Trees       Index       Help   

Zenoss

Package ZenEvents :: Module ActionRule :: Class ActionRule
[show private | hide private]
[frames | no frames]

Type ActionRule

                             object --+    
                                      |    
                            EventFilter --+
                                          |
                     object --+           |
                              |           |
                           Base --+       |
                                  |       |
                         Historical --+   |
                                      |   |
     object --+                       |   |
              |                       |   |
           Base --+                   |   |
                  |                   |   |
EtagSupport --+   |                   |   |
              |   |                   |   |
   LockableItem --+                   |   |
                  |                   |   |
           Resource --+               |   |
                      |               |   |
             Collection --+           |   |
                          |           |   |
         object --+       |           |   |
                  |       |           |   |
               Base --+   |           |   |
                      |   |           |   |
          CopyContainer --+           |   |
                          |           |   |
         object --+       |           |   |
                  |       |           |   |
               Base --+   |           |   |
                      |   |           |   |
             Navigation --+           |   |
                          |           |   |
         object --+       |           |   |
                  |       |           |   |
               Base --+   |           |   |
                      |   |           |   |
         object --+   |   |           |   |
                  |   |   |           |   |
         Persistent --+   |           |   |
                      |   |           |   |
             Persistent --+           |   |
                          |           |   |
         object --+       |           |   |
                  |       |           |   |
               Base --+   |           |   |
                      |   |           |   |
                   Tabs --+           |   |
                          |           |   |
            Traversable --+           |   |
                          |           |   |
         object --+       |           |   |
                  |       |           |   |
               Base --+   |           |   |
                      |   |           |   |
               Acquirer --+           |   |
                          |           |   |
              ObjectManager --+       |   |
                              |       |   |
         object --+           |       |   |
                  |           |       |   |
               Base --+       |       |   |
                      |       |       |   |
        RoleManager --+       |       |   |
                      |       |       |   |
            RoleManager --+   |       |   |
                          |   |       |   |
         object --+       |   |       |   |
                  |       |   |       |   |
               Base --+   |   |       |   |
                      |   |   |       |   |
     object --+       |   |   |       |   |
              |       |   |   |       |   |
           Base --+   |   |   |       |   |
                  |   |   |   |       |   |
         CopySource --+   |   |       |   |
                      |   |   |       |   |
     object --+       |   |   |       |   |
              |       |   |   |       |   |
           Base --+   |   |   |       |   |
                  |   |   |   |       |   |
              Owned --+   |   |       |   |
                      |   |   |       |   |
     object --+       |   |   |       |   |
              |       |   |   |       |   |
           Base --+   |   |   |       |   |
                  |   |   |   |       |   |
               Tabs --+   |   |       |   |
                      |   |   |       |   |
        Traversable --+   |   |       |   |
                      |   |   |       |   |
                  ZItem --+   |       |   |
                          |   |       |   |
         object --+       |   |       |   |
                  |       |   |       |   |
               Base --+   |   |       |   |
                      |   |   |       |   |
               Acquirer --+   |       |   |
                          |   |       |   |
         PrimaryPathManager --+       |   |
                              |       |   |
         object --+           |       |   |
                  |           |       |   |
               Base --+       |       |   |
                      |       |       |   |
          CopyContainer --+   |       |   |
                          |   |       |   |
           RelCopyContainer --+       |   |
                              |       |   |
             object --+       |       |   |
                      |       |       |   |
                   Base --+   |       |   |
                          |   |       |   |
                UndoSupport --+       |   |
                              |       |   |
       PrimaryPathObjectManager --+   |   |
                                  |   |   |
             object --+           |   |   |
                      |           |   |   |
                   Base --+       |   |   |
                          |       |   |   |
           Node --+       |       |   |   |
                  |       |       |   |   |
            Element --+   |       |   |   |
                      |   |       |   |   |
  ElementWithAttributes --+       |   |   |
                          |       |   |   |
            PropertyManager --+   |   |   |
                              |   |   |   |
             ZenPropertyManager --+   |   |
                                  |   |   |
                RelationshipManager --+   |
                                      |   |
                         object --+   |   |
                                  |   |   |
                       ZenModelBase --+   |
                                      |   |
                         object --+   |   |
                                  |   |   |
                          ZenPacker --+   |
                                      |   |
                             ZenModelRM --+
                                          |
                                         ActionRule

Rule applied to events that then executes an action on matching events.
Method Summary
  breadCrumbs(self, terminator)
Return the breadcrumb links for this object add ActionRules list.
  checkFormat(self)
Check that the format string has valid fields.
  getAddress(self)
Return the correct address for the action this rule uses.
  getEventFields(self)
Return list of fields used in format.
  getUser(self)
Return the user this action is for.
  getUserid(self)
Return the userid this action is for.
  manage_addActionRuleWindow(self, newId, REQUEST)
Add a ActionRule Window to this device
  manage_beforeDelete(self, item, container)
Clear state in alert_state before we are deleted.
  manage_deleteActionRuleWindow(self, windowIds, REQUEST)
Delete a ActionRule Window to this device
  manage_editActionRule(self, REQUEST)
Update user settings.
  nextActive(self)
  nextActiveNice(self)
  nextActiveWindow(self)
  nextDurationNice(self)
  repeatNice(self)
  sqlwhere(self)
Return sql where to select alert_state data for this event.
  _clearAlertState(self)
Clear state in alert_state before we are deleted.
Inherited from ZenModelRM: __init__, changePythonClass, creator, editableDeviceList, getCreatedTimeString, getDmdKey, getModificationTimeString, getSubObjects, getTreeItems, getZenRootNode, index_object, primarySortKey, reindex_all, rename, unindex_object, viewName, zmanage_addProperty, zmanage_delObjects, zmanage_delProperties, zmanage_editProperties, zmanage_exportObject, zmanage_importObject, zmanage_importObjects
Inherited from ZenModelBase: __call__, __hash__, all_meta_types, callZenScreen, checkValidId, createHierarchyObj, custPropertyIds, custPropertyMap, getDmd, getDmdObj, getDmdRoot, getHierarchyObj, getIdLink, getNowString, getObjByPath, getPrimaryDmdId, getZopeObj, helpLink, isLocalName, manage_deleteObjects, prepId, saveCustProperties, todayDate, view, visibleCustPropertyMap, yesterdayDate, zenpathjoin, zenpathsplit, zenScreenUrl, zentinelTabs
Inherited from RelationshipManager: addRelation, buildRelations, cb_isMoveable, checkRelations, exportXml, exportXmlProperties, exportXmlRelationships, getRelationshipManagerId, getRelationshipNames, getRelationships, lookupSchema, manage_addRelation, manage_removeRelation, manage_workspace, removeRelation, _getCopy, _notifyOfCopyTo, _setObject
Inherited from PrimaryPathObjectManager: _delObject
Inherited from RelCopyContainer: manage_linkObjects, manage_renameObject, manage_unlinkObjects, _getRelName, _getSourceObjects, _verifyObjectLink, _verifyObjectPaste
Inherited from CopyContainer: cb_dataItems, cb_dataValid, manage_clone, manage_CopyContainerAllItems, manage_CopyContainerFirstItem, manage_copyObjects, manage_cutObjects, manage_pasteObjects, manage_renameObjects, validClipData, _delOb, _get_id, _getOb, _setOb
Inherited from ObjectManager: __class_init__, __getitem__, _checkId, filtered_meta_types, hasObject, list_imports, manage_afterAdd, manage_afterClone, manage_delObjects, manage_exportObject, manage_FTPlist, manage_FTPstat, manage_hasId, manage_importObject, objectIds, objectIds_d, objectItems, objectItems_d, objectMap, objectMap_d, objectValues, objectValues_d, superValues, tpValues, _importObjectFromFile, _subobject_permissions
Inherited from Navigation: manage_zmi_logout
Inherited from Tabs: class_manage_path, filtered_manage_options, tabs_path_default, tabs_path_info
Inherited from Acquirer: __new__, __of__
Inherited from Persistent: __getattribute__, bobobase_modification_time, locked_in_version, modified_in_version
Inherited from Persistent: __delattr__, __getstate__, __reduce__, __setattr__, __setstate__, _p_activate, _p_deactivate, _p_delattr, _p_getattr, _p_invalidate, _p_setattr
Inherited from Collection: dav__init, DELETE, HEAD, listDAVObjects, PUT
Inherited from Resource: COPY, dav__simpleifhandler, dav__validate, LOCK, manage_DAVget, MKCOL, MOVE, OPTIONS, PROPFIND, PROPPATCH, TRACE, UNLOCK
Inherited from LockableItem: wl_clearLocks, wl_delLock, wl_getLock, wl_hasLock, wl_isLocked, wl_lockItems, wl_lockmapping, wl_lockTokens, wl_lockValues, wl_setLock
Inherited from EtagSupport: http__etag, http__parseMatchList, http__processMatchHeaders, http__refreshEtag
Inherited from Traversable: absolute_url, absolute_url_path, getPhysicalPath, restrictedTraverse, unrestrictedTraverse, virtual_url_path
Inherited from PrimaryPathManager: getPrimaryId, getPrimaryParent, getPrimaryPath, getPrimaryUrlPath, primaryAq
Inherited from ZItem: __len__, __repr__, getId, manage_editedDialog, raise_standardErrorMessage, this, title_and_id, title_or_id, tpURL
Inherited from CopySource: cb_isCopyable, cb_userHasCopyOrMovePermission, _canCopy, _postCopy, _setId
Inherited from Owned: changeOwnership, getOwner, getOwnerTuple, getWrappedOwner, manage_fixupOwnershipAfterAdd, owner_info, userCanTakeOwnership, _deleteOwnershipAfterAdd, manage_changeOwnershipType, manage_takeOwnership
Inherited from RoleManager: ac_inherited_permissions, access_debug_info, acquiredRolesAreUsedBy, get_local_roles, get_local_roles_for_userid, get_valid_userids, has_local_roles, manage_access, manage_defined_roles, manage_editRoles, manage_role, permission_settings, permissionsOfRole, possible_permissions, rolesOfPermission, userdefined_roles, users_with_local_role, valid_roles, validate_roles, validRoles, _addRole, _delRoles, _has_user_defined_role, _setRoles, manage_acquiredPermissions, manage_addLocalRoles, manage_changePermissions, manage_delLocalRoles, manage_permission, manage_setLocalRoles
Inherited from RoleManager: manage_getPermissionMapping, _isBeingAccessedAsZClassDefinedInstanceMethod, _isBeingUsedAsAMethod, manage_setPermissionMapping
Inherited from UndoSupport: get_request_var_or_attr, manage_undo_transactions, undoable_transactions
Inherited from ZenPropertyManager: deleteZenProperty, isLocal, manage_editProperties, saveZenProperties, setZenProperty, zenPropertyIds, zenPropertyItems, zenPropertyMap, zenPropertyOptions, zenPropertyPath, zenPropertyString, zenPropertyType, zenPropIsPassword, _setProperty, _setPropValue
Inherited from PropertyManager: getProperty, getPropertyType, hasProperty, manage_addProperty, manage_changeProperties, manage_changePropertyTypes, manage_delProperties, propdict, propertyIds, propertyItems, propertyLabel, propertyMap, propertyValues, valid_property_id, _delProperty, _delPropValue, _propertyMap, _updateProperty, _wrapperCheck
Inherited from ElementWithAttributes: getAttribute, getAttributeNode, getAttributes
Inherited from Element: getChildNodes, getElementsByTagName, getFirstChild, getLastChild, getNextSibling, getNodeName, getNodeType, getParentNode, getPreviousSibling, getTagName
Inherited from Node: getNodeValue, getOwnerDocument, hasChildNodes
Inherited from Historical: manage_afterHistoryCopy, manage_beforeHistoryCopy, manage_change_history, manage_historicalComparison, manage_historyCompare, manage_historyCopy
Inherited from ZenPacker: addToZenPack, findObject
Inherited from EventFilter: genMeta, getQueryElements, getWhere, getWhereClauseAsJavaScript, _whereClauseAsJavaScript
Inherited from Base: __getnewargs__
Inherited from object: __reduce_ex__, __str__
Inherited from SRE_Pattern: _onlystars

Class Variable Summary
tuple __ac_permissions__ = (('Change Settings', ('manage_delet...
str action = 'email'
tuple actionTypes = ('page', 'email')
str body = 'Device: %(device)s\nComponent: %(component)s\nSe...
str clearBody = "Event: '%(summary)s'\nCleared by: '%(clearS...
str clearFormat = '[zenoss] CLEAR: %(device)s %(clearOrEvent...
int delay = 0                                                                     
bool enabled = False
tuple factory_type_information = ({'product': 'ZenEvents', 'de...
str format = '[zenoss] %(device)s %(summary)s'
PermissionRole manage_addActionRuleWindow__roles__ = <PermissionRole ob...
tuple manage_beforeDelete__roles__ = ('Manager',)
PermissionRole manage_deleteActionRuleWindow__roles__ = <PermissionRole...
PermissionRole manage_editActionRule__roles__ = <PermissionRole object ...
str meta_type = 'ActionRule'
tuple meta_types = ()
str targetAddr = ''
str where = 'severity >= 4 and eventState = 0 and prodState ...
tuple _properties = ({'type': 'string', 'id': 'title', 'mode':...
tuple _relations = (('windows', <Products.ZenRelations.RelSche...
Inherited from ZenModelRM: default_catalog, getDmdKey__roles__, isInTree, primarySortKey__roles__, rename__roles__, viewName__roles__, zmanage_editProperties__roles__
Inherited from ZenModelBase: breadCrumbs__roles__, getPrimaryDmdId__roles__, helpLink__roles__, index_html, manage_deleteObjects__roles__, sub_meta_types, view__roles__, zentinelTabs__roles__
Inherited from RelationshipManager: manage_addRelation__roles__, manage_main, manage_main__roles__, manage_options, manage_removeRelation__roles__, manage_workspace__roles__, _operation
Inherited from CopyContainer: __implemented__, __providedBy__, __provides__, manage_clone__roles__, manage_CopyContainerAllItems__roles__, manage_CopyContainerFirstItem__roles__, manage_copyObjects__roles__, manage_cutObjects__roles__, manage_pasteObjects__roles__, manage_renameForm, manage_renameForm__roles__, manage_renameObject__roles__, manage_renameObjects__roles__
Inherited from ObjectManager: __roles__, isAnObjectManager, isPrincipiaFolderish, manage_addProduct, manage_afterAdd__roles__, manage_afterClone__roles__, manage_delObjects__roles__, manage_exportObject__roles__, manage_FTPlist__roles__, manage_FTPstat__roles__, manage_hasId__roles__, manage_importExportForm, manage_importExportForm__roles__, manage_importObject__roles__, manage_index_main, manage_index_main__roles__, objectIds__roles__, objectItems__roles__, objectValues__roles__, _objects
Inherited from Navigation: manage, manage__roles__, manage_copyright, manage_copyright__roles__, manage_form_title, manage_form_title__roles__, manage_menu, manage_menu__roles__, manage_page_footer, manage_page_footer__roles__, manage_page_header, manage_page_header__roles__, manage_page_style.css, manage_page_style.css__roles__, manage_top_frame, manage_top_frame__roles__, manage_zmi_logout__roles__, manage_zmi_prefs, manage_zmi_prefs__roles__, zope_quick_start, zope_quick_start__roles__
Inherited from Tabs: class_manage_path__roles__, filtered_manage_options__roles__, manage_tabs, manage_tabs__roles__
Inherited from Persistent: _p_changed, _p_jar, _p_mtime, _p_oid, _p_serial, _p_state
Inherited from Collection: __dav_collection__
Inherited from Resource: __dav_resource__, __http_methods__, COPY__roles__, DELETE__roles__, HEAD__roles__, listDAVObjects__roles__, LOCK__roles__, manage_DAVget__roles__, MOVE__roles__, OPTIONS__roles__, PROPFIND__roles__, PROPPATCH__roles__, TRACE__roles__, UNLOCK__roles__
Inherited from LockableItem: wl_clearLocks__roles__, wl_delLock__roles__, wl_getLock__roles__, wl_isLocked__roles__, wl_isLockedByUser__roles__, wl_lockItems__roles__, wl_lockmapping__roles__, wl_lockTokens__roles__, wl_lockValues__roles__, wl_setLock__roles__
Inherited from EtagSupport: __implements__
Inherited from Traversable: absolute_url__roles__, absolute_url_path__roles__, getPhysicalPath__roles__, getPhysicalRoot, getPhysicalRoot__roles__, restrictedTraverse__roles__, unrestrictedTraverse__roles__, virtual_url_path__roles__
Inherited from ZItem: __allow_access_to_unprotected_subobjects__, __name__, __propsets__, getId__roles__, icon, id, isTopLevelPrincipiaApplicationObject, REQUEST, title, _manage_editedDialog
Inherited from Owned: changeOwnership__roles__, getOwner__roles__, getOwnerTuple__roles__, getWrappedOwner__roles__, manage_changeOwnershipType__roles__, manage_fixupOwnershipAfterAdd__roles__, manage_owner, manage_owner__roles__, manage_takeOwnership__roles__, owner_info__roles__
Inherited from RoleManager: __ac_local_roles__, __ac_roles__, ac_inherited_permissions__roles__, access_debug_info__roles__, aclAChecked, aclEChecked, aclPChecked, acquiredRolesAreUsedBy__roles__, manage_access__roles__, manage_acquiredForm, manage_acquiredForm__roles__, manage_acquiredPermissions__roles__, manage_addLocalRoles__roles__, manage_changePermissions__roles__, manage_defined_roles__roles__, manage_delLocalRoles__roles__, manage_editLocalRoles, manage_editLocalRoles__roles__, manage_editRoles__roles__, manage_listLocalRoles, manage_listLocalRoles__roles__, manage_permission__roles__, manage_permissionForm, manage_permissionForm__roles__, manage_role__roles__, manage_roleForm, manage_roleForm__roles__, manage_setLocalRoles__roles__, permission_settings__roles__, permissionMappingPossibleValues, permissionsOfRole__roles__, rolesOfPermission__roles__, selectedRoles, smallRolesWidget, userdefined_roles__roles__, _method_manage_access, _normal_manage_access
Inherited from RoleManager: manage_getPermissionMapping__roles__, manage_setPermissionMapping__roles__
Inherited from UndoSupport: manage_undo_transactions__roles__, manage_UndoForm, manage_UndoForm__roles__, undoable_transactions__roles__
Inherited from ZenPropertyManager: manage_editProperties__roles__, manage_propertiesForm, manage_propertiesForm__roles__
Inherited from PropertyManager: getProperty__roles__, getPropertyType__roles__, hasProperty__roles__, manage_addProperty__roles__, manage_changeProperties__roles__, manage_changePropertyTypes__roles__, manage_delProperties__roles__, manage_propertyTypeForm, manage_propertyTypeForm__roles__, propdict__roles__, propertyIds__roles__, propertyItems__roles__, propertyLabel__roles__, propertyMap__roles__, propertysheets, propertyValues__roles__, valid_property_id__roles__, _reserved_names
Inherited from Historical: HistoricalRevisions, manage_afterHistoryCopy__roles__, manage_beforeHistoryCopy__roles__, manage_change_history__roles__, manage_change_history_page, manage_change_history_page__roles__, manage_historicalComparison__roles__, manage_historyCompare__roles__, manage_historyCopy__roles__, _manage_historyComparePage
Inherited from ZenPacker: security
Inherited from EventFilter: formName

Instance Method Details

breadCrumbs(self, terminator='dmd')

Return the breadcrumb links for this object add ActionRules list. [('url','id'), ...]
Overrides:
Products.ZenModel.ZenModelBase.ZenModelBase.breadCrumbs

checkFormat(self)

Check that the format string has valid fields.

getAddress(self)

Return the correct address for the action this rule uses.

getEventFields(self)

Return list of fields used in format.

getUser(self)

Return the user this action is for.

getUserid(self)

Return the userid this action is for.

manage_addActionRuleWindow(self, newId, REQUEST=None)

Add a ActionRule Window to this device

manage_beforeDelete(self, item, container)

Clear state in alert_state before we are deleted.
Overrides:
Products.ZenRelations.RelationshipManager.RelationshipManager.manage_beforeDelete

manage_deleteActionRuleWindow(self, windowIds, REQUEST=None)

Delete a ActionRule Window to this device

manage_editActionRule(self, REQUEST=None)

Update user settings.

sqlwhere(self)

Return sql where to select alert_state data for this event.

_clearAlertState(self)

Clear state in alert_state before we are deleted.

Class Variable Details

__ac_permissions__

Type:
tuple
Value:
(('Change Settings',
  ('manage_deleteActionRuleWindow',
   'manage_editActionRule',
   'manage_addActionRuleWindow')),)

action

Type:
str
Value:
'email'

actionTypes

Type:
tuple
Value:
('page', 'email')

body

Type:
str
Value:
'''Device: %(device)s
Component: %(component)s
Severity: %(severityString)s
Time: %(firstTime)s
Message:
%(message)s
<a href="%(eventUrl)s">Event Detail</a>
<a href="%(ackUrl)s">Acknowledge</a>
...

clearBody

Type:
str
Value:
"""Event: '%(summary)s'
Cleared by: '%(clearSummary)s'
At: %(clearFirstTime)s
Device: %(device)s
Component: %(component)s
Severity: %(severityString)s
Message:
%(message)s
...

clearFormat

Type:
str
Value:
'[zenoss] CLEAR: %(device)s %(clearOrEventSummary)s'

delay

Type:
int
Value:
0                                                                     

enabled

Type:
bool
Value:
False

factory_type_information

Type:
tuple
Value:
({'actions': ({'action': 'editActionRule',
               'id': 'edit',
               'name': 'Edit',
               'permissions': ('Change Settings',)},
              {'action': 'editActionRuleMessage',
               'id': 'message',
               'name': 'Message',
               'permissions': ('Change Settings',)},
...

format

Type:
str
Value:
'[zenoss] %(device)s %(summary)s'

manage_addActionRuleWindow__roles__

Type:
PermissionRole
Value:
<PermissionRole object at 0x10bfef0>

manage_beforeDelete__roles__

Type:
tuple
Value:
('Manager',)

manage_deleteActionRuleWindow__roles__

Type:
PermissionRole
Value:
<PermissionRole object at 0x10bfef0>

manage_editActionRule__roles__

Type:
PermissionRole
Value:
<PermissionRole object at 0x10bfef0>

meta_type

Type:
str
Value:
'ActionRule'

meta_types

Type:
tuple
Value:
()

targetAddr

Type:
str
Value:
''

where

Type:
str
Value:
'severity >= 4 and eventState = 0 and prodState = 1000'

_properties

Type:
tuple
Value:
({'type': 'string', 'id': 'title', 'mode': 'wd'},
 {'type': 'text', 'id': 'where', 'mode': 'w'},
 {'type': 'text', 'id': 'format', 'mode': 'w'},
 {'type': 'text', 'id': 'body', 'mode': 'w'},
 {'type': 'text', 'id': 'clearFormat', 'mode': 'w'},
 {'type': 'text', 'id': 'clearBody', 'mode': 'w'},
 {'type': 'int', 'id': 'delay', 'mode': 'w'},
 {'id': 'action',
...

_relations

Type:
tuple
Value:
(('windows',
  <Products.ZenRelations.RelSchema.ToManyCont instance at 0x3036c60>),\
)

   Trees       Index       Help   

Zenoss

Generated by Epydoc 2.1 on Thu Aug 16 09:55:13 2007 http://epydoc.sf.net