CFG-PLCY-MIB: View SNMP OID List / Download MIB

This version of MIB supports QoSWorks 1.9.2 or less sitaraCfgPlcyMIB MIB module describes Sitara's QosWorks/QosArray policy configuration objects

sitaraCfgPlcyVersion gives the policy version number, that policy agent supports. Policy Version Value VERSION 1 1.5 VERSION 2 N/A VERSION 3 3 VERSION 2 4 min/max/Buerst support

sitaraCfgPlcyPerRowUpdate object gives the ability to automatically update the sys.policy file when ever any row of the type specified by this object is moved to active. This object is checked when any of the rows in the following tables is moved to an active status: . Schedule Table : 0x01 . Link Table : 0x02 . Link Net Destination Table : 0x04 . Group Table : 0x08 . Class Table : 0x10 . Filter Table : 0x20 E.g. When schedule table Row status changes to Active, 0x01 bit is checked, if that is set sys.policy is updated and CBQD will be restarted. Care should be exercised when setting this object since the effect of enabling this automatic update of the sys.policy on a per row basis is that the sys.policy is written with each row's move to the active state. This also causes the queuing system to be restarted with the new parameters. For large change transactions, use the sitaraCfgPlcyGlobalStorage object.

When this object value is set to: saveToPerm(1) sys.policy is updated with information currently in all the objects in this subagent with the exception of the cross index table that is not part of the sys.policy information. CBQD will be re-started with the new information. clearAllTables(2) All entries in all tables are cleared. The subagent is reinitialized. syncRunningPlcy(3) All entries in all tables are cleared. The subagent is reinitialized and reads the currently saved sys.policy file. This ensures synchronization of the central policy manager with changes that have been made by the CLI or WEB interfaces. Enumeration: 'syncRunningPlcy': 3, 'unlock': 0, 'saveToPerm': 1, 'clearAllTables': 2.

sitaraCfgPlcyLastUpdateTime object contains the Date and Time when the Last policy is loaded

sitaraCfgPlcyApplyError object stores the message generated when sitaraCfgPlcyGlobalStorage is set to policy load/verify. If policy load is success then Message is Policy Apply SUCCESSFUL. If policy verify is success then Message is Policy Verify SUCCESSFUL. Message is trunkated to 1024 charecters

Cross Index table entry objects are the indices of the Schedule, Link, Link Network Destination, Group, CBQ Class and Filter Tables.

All objects in this table, except the sitaraCfgPlcyCrossIndex specify active indices of the rest of the tables in this MIB Module. All objects/indices in an entry need not be valid all the times. That is, an row in this table might have only one or two valid objects. When an entry is created in this table, index objects are initialized with an invalid value '0xffffffff' and all Alias (Those are indices to this table) are initialized with Octet String value '0', i.e. length=1, value =0

This object is used as one of the indices for cross index table. The value of this object will be the same as the values found in the sitaraCfgPlcySchdAlias.

This object is used as one of the indices for this table. A value of '0' indicates an as yet unassigned/created link in a schedule. In all other cases this value will be the same as values found in sitaraCfgPlcyLinkAlias.

This object is used as one of the indices for this table. A value of '0' indicates an as yet unassigned/created group for a particular link. In all other cases this value will be the same as values found in sitaraCfgPlcyGroupAlias.

This object is used as one of the indices for this table. A value of '0' indicates an as yet unassigned/created class for a particular group or link. In all other cases this value will be the same as values found in sitaraCfgPlcyCbqClassAlias.

This object is used as one of the indices for this table. A value of '0' indicates an as yet unassigned/created filter for a class. In all other cases this value will be the same as values found in sitaraCfgPlcyFilterAlias.

This object specifies the serial number for this row of the table and ensures uniqueness for each row.

The value of this object is the same as that contained in sitaraCfgPlcySchdIndex.

The value of this object is the same as sitaraCfgPlcySchdIndex. '0xffffffff' is used to to represent an as yet unassigned/created link in this schedule.

The value of this object is the same as sitaraCfgPlcyLinkNetDestNextIndex. '0xffffffff' is used to to represent as yet unassigned/created network destinations specifically targeted for this link as described in the sitaraCfgPlcyLinkNetDestTable.

The value of this object is the same as sitaraCfgPlcyGroupIndex. '0xffffffff' is used to to represent as yet unassigned/created group for this link.

The value of this object is the same as sitaraCfgPlcyCbqClassIndex. '0xffffffff' is used to to represent as yet unassigned/created class for this link or group.

The value of this object is the same as sitaraCfgPlcyFilterIndex. '0xffffffff' is used to to represent as yet unassigned/created filter for this class.

Next available Schedule Table index. This object contains the value that a management application should use when creating a new entry in the sitaraCfgPlcySchdTable. When a row is created with this value, the sitaraCfgPlcySchdNextIndex increment by one. In the boundary case where another manager has accessed the value at the same time and attempted to create a row in sitaraCfgPlcySchdNextIndex with the same index value, the second manager will receive and error notification. The semantic for this object is designed to avoid the problem of objects in other MIB Modules that increment on each read causing a more rapid wrap. In both cases the manager must be prepared to receive a message from the agent that the row is already in use since some rows may be long lived.

Schedule Table sits in the top of the policy Management tree. Each entry of this table gives schedule time interval at which the policy to be applied. This table is linked to the Link table.

Each entry includes the Start-Time and End-Time of the days as specified by the DaysOfWeek textual convention: E.g.: Start-Time :09:00 End-Time :18:00 DaysOfWeek : 0x7c The parameters above would describe a schedule that is active between 9am to 6pm on week days Monday to Friday inclusive.

sitaraCfgPlcySchdIndex is a unique value for each schedule entry.

The schedule alias must be unique for every row of this table. If an alias is 'foo' it would be allowed only in one row of this table. It would also be allowed to exist once in the respective alias fields of the other tables in this MIB Module, specifically the link, group, class and filter tables.

Specifies the days of the week this schedule entry is to be active. When a new schedule is created, the default is that it is not active any time, meaning no days of the week.

Object sitaraCfgPlcySchdStartTime gives the start time of the schedule identified by this row of the table for the days of the week the schedule is active as specified in the sitaraCfgPlcySchdDaysOfWeek object. If zone is information is not supplied, time is treated as Local time. If zone information is supplied with this object, the system will calculate the correct offset.

Object sitaraCfgPlcySchdEndTime gives the end time of the schedule identified by this row of the table for the days of the week the schedule is active as specified in the sitaraCfgPlcySchdDaysOfWeek object. If zone is not supplied, time is treated as Local time. If zone information is supplied with this object, the system will calculate the correct offset.

Object sitaraCfgPlcySchdOwner should be set by the owner of this table row entry immediately after creating the entry. The owner is the user or management system that sent the commands to the system to create this row.

The sitaraCfgPlcySchdPolicyStatus object can be set with the following values: running(1), -- Contents of the row are -- running in the current policy -- configuration. pending(2) -- Contents of the row are -- not running in the curent policy -- configuration. When a row is created, the value of this object is initialized with Pending. When a policy is updated successfully and the system is reinitialized with the new represented by this row of the table, then value is changed from Pending to Running.

Current status of the Schedule Table Entry. When ever this status is set to active and the sitaraCfgPlcyPerRowUpdate object value bit 0x01 is set, the sys.policy file is updated and CBQD will be re-started with these new values.

Next available Link Table index. This object is used by management applications to determine the value to use for sitaraCfgPlcyLinkIndexindex when creating a new row in the sitaraCfgPlcyLinkTable.

The Link Table contains information about links that have been defined to the QosWorks device. Each schedule will contain one or more active links. Each link can contain one or more groups which are in turn comprised of classes. Classes can also be directly contained in links.

A link alias such as Boston, may appear several times in this table if it is used in several schedules. It is the combination of sitaraCfgPlcySchdIndex and sitaraCfgPlcyLinkIndex that provide uniqueness. The indexing in this table does allow the retrieval of all links associated with a schedule.

A unique value for each Link Entry. A new index value will be used each time a link is associated with a schedule. The sitaraCfgPlcyLinkNextIndex is the object to be used to determine what the next available Link Index should be.

The Link Alias is the name associated with the link identified in this row of the table. Since a link may be used in several schedules, it is possible that a link will appear in more than one row of this table.

Path Name gives the full specification of this link which includes both the schedule and link information. See the PolicyPathName textual convention.

The current status of this link in this schedule. Enumeration: 'disabled': 2, 'enabled': 1.

Descriptive information about this link entry.

The bandwidth in kilobits per second allocated to this link in the LAN direction.

The bandwidth limit that traffic in the LAN direction is allowed to burst to on this link. This is measured in kilobits per second.

Available bandwidth in the LAN direction for this link. Available bandwidth is the amount of capacity that remains after all the bandwidth that has been configured for all child groups and classes has been subtracted.

Link bandwidth in the WAN direction.

Link Burst bandwidth in the WAN direction.

Available link bandwidth in the WAN direction. Available bandwidth is the amount of capacity that remains after all the bandwidth that has been configured for all child groups and classes has been subtracted.

sitaraCfgPlcyLinkOwner object is used to identify the Owner of the row which will usually be the identity of the management software or user that created this link. Formate of the Owner string as follows: Owner String = ScheduleAlias(PolicyName):LinkPathName:LinkCustomerID

The sitaraCfgPlcyLinkPolicyStatus object can be set with the following values: running(1), -- Contents of the row are -- running in the current policy -- configuration. pending(2) -- Contents of the row are -- not running in the curent policy -- configuration. When a row is created, the value of this object is initialized with Pending. When a policy is updated successfully and the system is reinitialized with the new represented by this row of the table, then value is changed from Pending to Running.

The current status of this row of the link table.

The next available Link Network Destination Address Table index to be used to create a new entry in the network destination address table.

The Link Network Destination Address table gives the IP Addresses and network masks for links that are intended to carry traffic only to specfic destination networks.

Each entry consists of a destination IP Address and corresponding network mask. Each new link created should have at least one destination network specified for IP traffic. See the policy filter table for additional detail.

A unique value for each network destination entry. A new index value must be used each time a row is created in this table to associate a network destination with a link. The sitaraCfgPlcyLinkNetDestNextIndex is the object to be used to determine what the next available Link Net Dest Index should be.

IP address of the destination network.

The network mask to be used in association with the sitaraCfgPlcyLinkNetDestAddr.

Object sitaraCfgPlcyLinkNetDestOwner is used to identify the Owner of the row. This will usually be the management system or user that created this row of the table.

Current status of status information identified by the table row entry.

Next available index to be used to create an entry in the sitaraCfgPlcyGroupTable.

Class groups provide a parent level for two or more classes. This makes it possible to enforce bandwidth and bursting restrictions by group as well as individual class.

Each entry contains the information about the bandwidth, burst and name of the group. When an entry is created, resources (Bandwidth, Burst..) should be less than the available resources at the parent which could either be a link or a group since the system allows creation of groups that contain groups.

Unique value for each entry. A new index value must be used each time a row is created in this table to associate a group with a Link. The sitaraCfgPlcyGroupNextIndex is the object to be used to determine what the next available Group Index should be.

The group alias is unique identifier in the Group Table. See the PolicyAlias and PolicyPathName textual conventions for additional details.

The fully qualified unique path to this policy element. See the PolicyAlias and PolicyPathName textual conventions for additional information.

sitaraCfgPlcyGroupEnabled is to specify whether this entry is enabled or disabled. Enumeration: 'disabled': 2, 'enabled': 1.

A description of the group defined in the table row entry.

Group bandwidth in the LAN direction. This should be less than the parent available bandwidth.

Group Burst bandwidth in the LAN direction. This should be less than the parent group/link available burst bandwidth.

Available bandwidth in LAN direction for this group. Available bandwidth is the amount of capacity that remains after all the bandwidth that has been configured for all child groups and classes in a link has been subtracted.

Group bandwidth in WAN direction. This should be less than the parent available Band width

Group Burst bandwidth in WAN direction. This should be less than the parent available Burst bandwidth.

Available bandwidth in WAN direction for this group. Available bandwidth is the amount of capacity that remains after all the bandwidth that has been configured for all child groups and classes has been subtracted.

The policy group traffic direction object indicates the directionality of this flow. Based on the value of this object, the LAN and WAN bandwidth paramerts will be filled in. If this is a bi-directional flow, values for both the LAN and WAN objects should be supplied.

Object sitaraCfgPlcyGroupParentIndex contains the value of a parent group is this group is desired to be a child of another group. If the value of this object is 0 then this group is not a member of another group and is a direct child of the link specified in the index of this table.

Object sitaraCfgPlcyGroupOwner is used to identify the owner of the information identified in this row of the table. Formate of the Owner string as follows: Owner String = ScheduleAlias(PolicyName):GroupPathName

The sitaraCfgPlcyGroupPolicyStatus PolicyStatus object can be set with the following values: running(1), -- Contents of the row are -- running in the current policy -- configuration. pending(2) -- Contents of the row are -- not running in the curent policy -- configuration. When a row is created, the value of this object is initialized with Pending. When a policy is updated successfully and the system is reinitialized with the new represented by this row of the table, then value is changed from Pending to Running.

Current status of this table row.

The next available CBQ class table index.

The sitaraCfgPlcyCbqClassTable contains an entry for each CBQ policy associated with a particular service. Classes provide the finest resolution available for bandwidth allocation. A single class is typically shared by several categories of traffic which each category defined as a filter. See the sitaraCfgPlcyFilterTable.

Locally held information about a particular CBQ policy.

A unique value for each CbqClass Entry. A new index value will be used each time a CbqClass is associated with a Link/Group creating a new row in this table . The sitaraCfgPlcyCbqClassNextIndex is the object to be used to determine what the next available CbqClass Index should be.

The class Alias is unique identifier in the Class Table, for a schedule. See the textual convention information at the beginning of this module for PolicyAlias and PolicyPathName for correct usage information.

sitaraCfgPlcyCbqClassPathName object contains the fully specified path to this policy element. The last node in the path is the alias described in this row of the table.

The current status of this policy element. Enumeration: 'disabled': 2, 'enabled': 1.

Class bandwidth in LAN direction. This object should be set to less than the parent available bandwidth.

Class burst bandwidth in LAN direction. This should be less than the parent link or group's available burst bandwidth.

sitaraCfgPlcyCbqClassLanPriority gives the priority of the Class in the LAN direction.

sitaraCfgPlcyCbqClassLanSessionBw specifies the minimum session bandwidth in the LAN direction for TCP/IP traffic.

Describes the admission rule for a session. The purpose of this object is to allow the system to determine the action to take when new requests are recieved by the system for sessions when the allocated limit for this class has been reached. Depending on the value of this object, new requests can be granted with reduced bandwith, rejected, etc. See the AdmissionState textual convention for more information.

sitaraCfgPlcyCbqClassLanHttpCaching gives the status whether HTTP caching i.e. enabled or not in the LAN direction. This class-level attribute applies only for HTTP traffic. It enables caching WEB pages that are handeled by the class. Enumeration: 'disabled': 2, 'enabled': 1.

Used to enable or disable type of service remarking in the LAN direction. Enumeration: 'disabled': 2, 'enabled': 1.

Type of service value that will be written to packets in this class when they exit the QosWorks device.

Mask applied to the TOS value above.

MTU value in the Lan direction specified in units 'bytes'

sitaraCfgPlcyCbqClassLanMaxDelay specifies maximum delay in the Lan direction in 'milli sec'. Lower and upper limits for the delay is calulated from the following formulas lower bound delay = roundUp ( 4 * 8 * MTU / BW (in kbps)) upper bound delay = roundDown (200 * 8 * MTU / BW (in kbps))

Class bandwidth in WAN direction. This should be less than the available bandwidth of the parent group or link.

Class Burst bandwidth in WAN direction. This should be less than the available burst bandwidth for the parent group or link.

sitaraCfgPlcyCbqClassWanPriority gives the priority this class should receive relative to all other traffic in the WAN direction.

sitaraCfgPlcyCbqClassWanSessionBw specifies the minimum session bandwidth in the WAN direction for TCP/IP traffic.

sitaraCfgPlcyCbqClassWanAdminCtrl allows the system to determine the action to take when new requests are recieved by the system for sessions in the WAN direction when the allocated limit for this class has been reached. Depending on the value of this object, new requests can be granted with reduced bandwith, rejected, etc. See the AdmissionState textual convention for more information.

Used to enable or disable WEB caching. This is applicable for classes that handle HTTP traffic. The value should be 2 - disabled for those clases that do not handle HTTP traffic or for those classes that do, but for which caching is not desired. Enumeration: 'disabled': 2, 'enabled': 1.

Used to control type of service remarking in the WAN direction. Enumeration: 'disabled': 2, 'enabled': 1.

New TOS value to be applied to traffic in this class in the WAN direction.

Mask for the TOS value in the WAN direction.

MTU value in the Wan direction specified in units 'bytes'

This object specifies maximum delay in the Wan direction in 'milli sec'. Lower and upper limits for the delay is calulated from the following formulas lower bound delay = roundUp ( 4 * 8 * MTU / BW (in kbps)) upper bound delay = roundDown (200 * 8 * MTU / BW (in kbps))

Cbq Class Traffic direction. Note that the value of this object will determine whether the LAN, WAN or both sets of objects for LAN and WAN parameters are relevant for this class of traffic.

sitaraCfgPlcyCbqClassOwner is used to identify the table row owner for this class. Usually this will either be a user or the management system that created the row in the table. Formate of the Owner string as follows: Owner String = ScheduleAlias(PolicyName):ClassPathName

A textual description for this class.

The sitaraCfgPlcyCbqClassPolicyStatus PolicyStatus object can be set with the following values: running(1), -- Contents of the row are -- running in the current policy -- configuration. pending(2) -- Contents of the row are -- not running in the curent policy -- configuration. When a row is created, the value of this object is initialized with Pending. When a policy is updated successfully and the system is reinitialized with the new represented by this row of the table, then value is changed from Pending to Running.

Current status of the sitaraCfgPlcyCbqClass entry.

Class Minmum Burst bandwidth in LAN direction. Value 0 specified invalid or not defined

Class Maxmum Burst bandwidth in LAN direction. Value 0 specified invalid or not defined

Class Minmum Burst bandwidth in WAN direction. Value 0 specified invalid or not defined

Class Maxmum Burst bandwidth in WAN direction. Value 0 specified invalid or not defined

Next available Filter Table index value.

The sitaraCfgPlcyFilterTable contains an entry for each filter associated with a particular CBQ Class. Each Class defined in the sitaraCfgPlcyCbqClassTable may have one or more filters associated with it.

Locally held information about a particular policy filter.

A unique value for each filter entry. A new index value will be used each time a Filter is associated with a Class. The sitaraCfgPlcyFilterNextIndex is the object to be used to determine what the next available filter index should be.

The filter alias is unique identifier in the Filter Table for a schedule. See the textual convention information at the beginning of this module for PolicyAlias and PolicyPathName for correct usage information.

sitaraCfgPlcyFilterPathName contains the fully specified path to this policy element. The last node in the path is the alias described in this row of the table.

Protocol identifier associated with a particular filter.

The starting IP port number of a range of port numbers for the filter in the LAN direction. When the sitaraCfgPlcyFilterLanIpEndPort is less than sitaraCfgPlcyFilterLanIpStartPort, then the range contains only one port number, the sitaraCfgPlcyFilterLanIpStartPort number.

The ending IP port number of the port range in the LAN direction. To specify a range this value should be more then the Start port number. If the end port number is less than the start port number, then the range will contain only one port number, the starting port number.

IP address associated with the policy filter if the filter address is on the LAN side of the QosWorks device.

Network mask associated with the policy filter if the filter address is on the LAN side of the QosWorks device.

Starting IP port number of a port range in the WAN direction. The sitaraCfgPlcyFilterWanIpStartPort, sitaraCfgPlcyFilterWanIpEndPort, sitaraCfgPlcyFilterWanIpAddr, and sitaraCfgPlcyFilterWanNetMask have the same semanitcs as their LAN based equivalents only they control behavior for addresses, ports, and network masks for filters on the WAN side of the QosWorks device.

Ending IP port number of the Port range in the WAN direction.

IP source address associated with the policy filter in the WAN direction.

Network mask associated with the policy filter IP address on the WAN side of the QosWorks device.

The order in which the filters are to be evaluated.

Used to identify the owner of this row in the table.

A textual description of this filter entry.

Policy status takes following values. See the PolicyStatus textual convention.

Current status of the sitaraCfgPlcyFilter entry.

Used to enable or disable TOS type of service of this filter. The TOS value is only applied to IP traffic so for nonIP, this should not be used. Enumeration: 'disabled': 2, 'enabled': 1.

Type of service value that will be written to packets in this class when they exit the Sitara QoS device.

Mask applied to the TOS value above.

sitaraCfgPlcyNotifnsPlcyUpdate notification is generated when sitaraCfgPlcyGlobalStorage object is set. This notification could be generated when policy is successfuly Loaded/Verified

sitaraCfgPlcyNotifnsCbqdReStart notification is generated when CBQD is restarted.

sitaraCfgPlcyNotifnsFailToReStart, failure notification, is generated when there is failure to Restart the Cbqd based on a restart request initiated by the sub agent that realizes this MIB Module.

sitaraCfgPlcyNotifnsFailToUpdatePolicy notification is generated when there has been a failure to load/Verify the policy

sitaraCfgPlcyNotifnsFailToXlatePolicy failure notification is generated when there has been a failure to translate the policy to cbqd conf file.

sitaraCfgPlcyNotifnsInvalidPolicy notification is generated when a row in any of the policy tables becomes invalid due to deletion of some of the objects/rows in the valid policy. This notification could be generated when agent detects invalid policy

sitaraCfgPlcyNotifnsSchdEntryUpdate notification is generated when the sitaraCfgPlcySchdStatus object's status is changed from/to active. This notification message contains SitaraCfgPlcySchdEntry objects

sitaraCfgPlcyNotifnsLinkEntryUpdate notification is generated when the sitaraCfgPlcyLinkStatus object's status is changed from/to active. This notification message contains SitaraCfgPlcyLinkEntry objects

sitaraCfgPlcyNotifnsNetDestEntryUpdate notification is generated when the sitaraCfgPlcyLinkNetDestStatus object's status is changed from/to active. This notification message contains SitaraCfgPlcyLinkNetDestEntry objects

sitaraCfgPlcyNotifnsGroupEntryUpdate notification is generated when the sitaraCfgPlcyGroupStatus object's status is changed from/to active. This notification message contains SitaraCfgPlcyGroupEntry objects

sitaraCfgPlcyNotifnsClassEntryUpdate notification is generated when the sitaraCfgPlcyCbqClassStatus object's status is changed from/to active. This notification message contains SitaraCfgPlcyCbqClassEntry objects

sitaraCfgPlcyNotifnsFilterEntryUpdate notification is generated when the sitaraCfgPlcyFilterstatus object's status is changed from/to active. This notification message contains SitaraCfgPlcyFilterEntry objects

sitaraCfgPlcyNotifnsPlcySyncUp notification is generated when Policy agent Sync up with the policy updated by other than SNMP policy agent (Policy update could be from CLI/WebUI)

sitaraCfgPlcyNotifnsPlcySyncUp notification is generated when Policy agent Failed to Sync up with the policy updated by other than SNMP policy agent (Policy update could be from CLI/WebUI)