Package onep :: Package element :: Module CLIFilter :: Class CLIFilter
[frames] | no frames]

Class CLIFilter


Implements the EventFilter abstract class for filtering a CLI event

Implements the EventFilter abstract class for filtering a CLI event according to the specified criteria.

A Filter can be used to provide fine-tuned control over which events to listen to.

Instance Methods
 
__init__(self, pattern)
Constructs a CLIFilter with specified regular expression pattern,
 
get_skip(self)
 
set_skip(self, skip)
 
get_sync(self)
 
set_sync(self, sync)

Inherited from object: __delattr__, __format__, __getattribute__, __hash__, __new__, __reduce__, __reduce_ex__, __repr__, __setattr__, __sizeof__, __str__, __subclasshook__

Class Variables
  skip = property(get_skip, set_skip)
The skip flag.
  sync = property(get_sync, set_sync)
The sync flag.
Properties

Inherited from object: __class__

Method Details

__init__(self, pattern)
(Constructor)

 

Constructs a CLIFilter with specified regular expression pattern,

Using a pattern string filter to perform CLI message pattern matching. Specifying a pattern parameter is mandatory in order to register for events.

Parameters:
  • pattern - Sets the pattern string used by the filter. It is a regular expression used to perform CLI message pattern matching.
Overrides: object.__init__

Class Variable Details

skip

The skip flag.

Any value other than zero indicates that default command will not be run when the pattern is matched in the network element.

Note: if sync is set to true, skip cannot also be true.

Value:
property(get_skip, set_skip)

sync

The sync flag.

Any value other than zero indicates that default command will be run synchronously with the listener.

Note: if skip is set to true, sync cannot also be true.

Value:
property(get_sync, set_sync)