Package onep :: Package policyservice :: Module action
[frames] | no frames]

Module action

Classes
  Action
The Action class is an abstract class that represents an action to be applied to a policy entry (PolicyMap.Entry).
  OutInterface
Action to direct packet to an output interface.
  MPLS
Action class for MPLS
  Mark
Action to mark packet.
  Police
Action to police traffic.
  Shape
Action to shape traffic.
  PriorityQueue
Action to control traffic priority queue.
  ClassQueue
Action to control traffic class-based queue.
  Bandwidth
Bandwidth action
  FairQueue
Action to set configure fair queue.
  QueueLimit
Action to set queue limit.
  WRED
Action to set to set Weighted Random Early Detect
  WREDProfile
Action to set to set Weighted Random Early Detect Profile
  PacketCopy
Action to copy packet to an application.
  PacketDivert
Action to copy packet to an application.
  VLAN
Action to set the top most VLAN ID.
  IpProtocol
Set IP protocol field in L3 header http://www.iana.org/assignments/protocol-numbers/protocol-numbers.xhtml
  IpAddress
Set source or destination IP Address field in L3 header
  Port
Set port field in L4 header
  MACAddress
Action to set to source or destination MAC address.
  Drop
Action to drop packets
  NextHop
Action to set next hop.
  ForwardClass
Forward packets to Class
Variables
Enum ActionType = enum(NONE= 0, DROP= 1, COPY= 2, DIVERT= 3, XMIT= ...
Enum representing desired action for packets matching the policy criteria.
Enum RateUnits = enum(RATE_UNITS_BPS= 1, RATE_UNITS_PERCENT= 2)
Enum for rate units
Enum BurstUnits = enum(BURST_UNITS_BITS= 1, BURST_UNITS_MSEC= 2)
Enum for burst units
Enum ThresholdUnits = enum(UNITS_PKTS= 1, UNITS_BYTES= 2, UNITS_CEL...
Enum for threshold units
Enum Direction = enum(SOURCE= 0, DESTINATION= 1)
Enum representing whether the action is to the source or the destination.
Enum ShapeType = enum(SHAPE_AVG= 1, SHAPE_PEAK= 2)
Enum representing the traffic shape types..
Enum QueueSizeUnits = enum(QUEUE_UNITS_PKTS= 1, QUEUE_UNITS_BYTES= ...
Enum representing the units of QueueSize.
Enum WREDType = enum(WRED_DSCP= 1, WRED_L2_COS= 2)
Enum representing the WRED Type.
Variables Details

ActionType

Enum representing desired action for packets matching the policy criteria. Network Element will report which actions it is capable of using capability APIs in onep.policyservice.caps module.

Type:
Enum
Value:
enum(NONE= 0, DROP= 1, COPY= 2, DIVERT= 3, XMIT= 4, SET_QOS_GROUP= 5, \
SET_MPLS_EXP= 6, SET_DSCP= 7, MARK= 8, SET_MPLS_EXP_TOPMOST= 9, SET_TU\
NNEL_DSCP= 10, HDR_COMPRESS= 11, OUTPUT_INTERFACE= 12, POLICE= 13, SHA\
PE= 14, WRED= 15, PRIORITY_QUEUE= 16, CLASS_BASED_QUEUE= 17, FAIR_QUEU\
E= 18, QUEUE_LIMIT= 19, NEXT_HOP= 20, SET_TOS= 21, SET_DST_MAC= 22, SE\
T_SRC_MAC= 23, SET_DST_IP= 24, SET_SRC_IP= 25, SET_DST_UDP_PORT= 26, S\
ET_DST_TCP_PORT= 27, SET_DST_SCTP_PORT= 28, SET_SRC_UDP_PORT= 29, SET_\
SRC_TCP_PORT= 30, SET_SRC_SCTP_PORT= 31, SET_IP_PROTOCOL= 32, SET_VLAN\
...

ThresholdUnits

Enum for threshold units

Type:
Enum
Value:
enum(UNITS_PKTS= 1, UNITS_BYTES= 2, UNITS_CELLS= 3, UNITS_PERCENT= 4, \
UNITS_MSEC= 5)

Direction

Enum representing whether the action is to the source or the destination. SOURCE: Source DESTINATION: Destination

Type:
Enum
Value:
enum(SOURCE= 0, DESTINATION= 1)

ShapeType

Enum representing the traffic shape types..

SHAPE_AVG: Shape average SHAPE_PEAK: Shape peak

Type:
Enum
Value:
enum(SHAPE_AVG= 1, SHAPE_PEAK= 2)

QueueSizeUnits

Enum representing the units of QueueSize.

QUEUE_UNITS_PKTS: Unit in packets QUEUE_UNITS_BYTES: Unit in bytes QUEUE_UNITS_MSEC: Unit in milliseconds

Type:
Enum
Value:
enum(QUEUE_UNITS_PKTS= 1, QUEUE_UNITS_BYTES= 2, QUEUE_UNITS_MSEC= 3)

WREDType

Enum representing the WRED Type.

WRED_DSCP: DSCP-based

WRED_L2_COS: L2 COS-based

Type:
Enum
Value:
enum(WRED_DSCP= 1, WRED_L2_COS= 2)