Trees       Indices       Help   
Zenoss
Package Products :: Package ZenModel :: Module IpService :: Class IpService
[hide private]
[frames] | no frames]

Class IpService

source code

                                                            object --+                
                                                                     |                
                                                     Lockable.Lockable --+            
                                                                         |            
                                           DeviceComponent.DeviceComponent --+        
                                                                             |        
                                                        object --+           |        
                                                                 |           |        
                                         ZenModelBase.ZenModelBase --+       |        
                                                                     |       |        
                               ExtensionClass.Base --+               |       |        
                                                     |               |       |        
                         OFS.CopySupport.CopyContainer --+           |       |        
                                                         |           |       |        
              ZenRelations.RelCopySupport.RelCopyContainer --+       |       |        
                                                             |       |       |        
                               ExtensionClass.Base --+       |       |       |        
                                                     |       |       |       |        
                         OFS.CopySupport.CopyContainer --+   |       |       |        
                                                         |   |       |       |        
                               ExtensionClass.Base --+   |   |       |       |        
                                                     |   |   |       |       |        
                             App.Management.Navigation --+   |       |       |        
                                                         |   |       |       |        
                               ExtensionClass.Base --+   |   |       |       |        
                                                     |   |   |       |       |        
                                   App.Management.Tabs --+   |       |       |        
                                                         |   |       |       |        
                                  Acquisition.Implicit --+   |       |       |        
                                                         |   |       |       |        
                                Persistence.Persistent --+   |       |       |        
                                                         |   |       |       |        
                           ExtensionClass.Base --+       |   |       |       |        
                                                 |       |   |       |       |        
            webdav.EtagSupport.EtagSupport --+   |       |   |       |       |        
                                             |   |       |   |       |       |        
                  webdav.Lockable.LockableItem --+       |   |       |       |        
                                                 |       |   |       |       |        
                          webdav.Resource.Resource --+   |   |       |       |        
                                                     |   |   |       |       |        
                          webdav.Collection.Collection --+   |       |       |        
                                                         |   |       |       |        
                           OFS.Traversable.Traversable --+   |       |       |        
                                                         |   |       |       |        
                           OFS.ObjectManager.ObjectManager --+       |       |        
                                                             |       |       |        
                               ExtensionClass.Base --+       |       |       |        
                                                     |       |       |       |        
                           ExtensionClass.Base --+   |       |       |       |        
                                                 |   |       |       |       |        
                        OFS.CopySupport.CopySource --+       |       |       |        
                                                     |       |       |       |        
                           ExtensionClass.Base --+   |       |       |       |        
                                                 |   |       |       |       |        
                               App.Management.Tabs --+       |       |       |        
                                                     |       |       |       |        
                       OFS.Traversable.Traversable --+       |       |       |        
                                                     |       |       |       |        
                           ExtensionClass.Base --+   |       |       |       |        
                                                 |   |       |       |       |        
                         AccessControl.Owned.Owned --+       |       |       |        
                                                     |       |       |       |        
                              ZenRelations.ZItem.ZItem --+   |       |       |        
                                                         |   |       |       |        
                                  Acquisition.Implicit --+   |       |       |        
                                                         |   |       |       |        
                               ExtensionClass.Base --+   |   |       |       |        
                                                     |   |   |       |       |        
       AccessControl.PermissionMapping.RoleManager --+   |   |       |       |        
                                                     |   |   |       |       |        
                        AccessControl.Role.RoleManager --+   |       |       |        
                                                         |   |       |       |        
  ZenRelations.PrimaryPathObjectManager.PrimaryPathManager --+       |       |        
                                                             |       |       |        
                                   ExtensionClass.Base --+   |       |       |        
                                                         |   |       |       |        
                                      App.Undo.UndoSupport --+       |       |        
                                                             |       |       |        
ZenRelations.PrimaryPathObjectManager.PrimaryPathObjectManager --+   |       |        
                                                                 |   |       |        
                                                    object --+   |   |       |        
                                                             |   |   |       |        
                                   ExtensionClass.Base --+   |   |   |       |        
                                                         |   |   |   |       |        
                                 OFS.ZDOM.Node --+       |   |   |   |       |        
                                                 |       |   |   |   |       |        
                                  OFS.ZDOM.Element --+   |   |   |   |       |        
                                                     |   |   |   |   |       |        
                        OFS.ZDOM.ElementWithAttributes --+   |   |   |       |        
                                                         |   |   |   |       |        
                       OFS.PropertyManager.PropertyManager --+   |   |       |        
                                                             |   |   |       |        
            ZenRelations.ZenPropertyManager.ZenPropertyManager --+   |       |        
                                                                 |   |       |        
              ZenRelations.RelationshipManager.RelationshipManager --+       |        
                                                                     |       |        
                                           ExtensionClass.Base --+   |       |        
                                                                 |   |       |        
                                            OFS.History.Historical --+       |        
                                                                     |       |        
                                                        object --+   |       |        
                                                                 |   |       |        
                                               ZenPacker.ZenPacker --+       |        
                                                                     |       |        
                                                 ZenModelRM.ZenModelRM --+   |        
                                                                         |   |        
                                       DeviceResultInt.DeviceResultInt --+   |        
                                                                         |   |        
                                                            object --+   |   |        
                                                                     |   |   |        
                                                   EventView.EventView --+   |        
                                                                         |   |        
                                                            object --+   |   |        
                                                                     |   |   |        
                                                       RRDView.RRDView --+   |        
                                                                         |   |        
                                               ManagedEntity.ManagedEntity --+        
                                                                             |        
                                                       OSComponent.OSComponent --+    
                                                                                 |    
                                                       Commandable.Commandable --+    
                                                                                 |    
                                                                    object --+   |    
                                                                             |   |    
                                                       ZenPackable.ZenPackable --+    
                                                                                 |    
                                                                   Service.Service --+
                                                                                     |
                                                                                    IpService

IpService object

Instance Methods [hide private]
 
monitored(self)
Return monitored state of ipservice.		 source code
 
cantMonitor(self)
Return true if IpService only listens on 127.0.0.1, or if it is a UDP service.		 source code
 
getInstDescription(self)
Return some text that describes this component.		 source code
 
setServiceClass(self, kwargs)
Set the service class based on a dict describing the service.		 source code
 
getSendString(self) source code
 
getExpectRegex(self) source code
 
getServiceClass(self)
Return a dict like one set by IpServiceMap for services.		 source code
 
primarySortKey(self)
Hook for the value used to sort this object.		 source code
string
getManageIp(self)
A service can listen on multiple interfaces on a device, and the interface it listens on may not be the same one that is the manageIp for the device.		 source code
string
_getManageIp(self)
Pick an IP out of available choices.		 source code
 
setManageIp(self, manageIp)
Manually set the management IP address to check the service status.		 source code
 
unsetManageIp(self)
Remove a prevously set management IP address to check the service status.		 source code
array of strings
getIpAddresses(self)
List the IP addresses to which we can contact the service.		 source code
 
getProtocol(self) source code
 
getPort(self) source code
 
getKeyword(self) source code
 
getDescription(self) source code
 
ipServiceClassUrl(self) source code
 
manage_editService(self, id=None, status=None, ipaddresses=None, manageIp=None, protocol=None, port=None, description=None, monitor=False, severity=5, sendString="", expectRegex="", REQUEST=None)
Edit a Service from a web page.		 source code

Inherited from Service.Service: getAqChainForUserCommands, getClassObject, getFailSeverity, getFailSeverityString, getServiceClassLink, getSeverities, getStatus, getUrlForUserCommands, getUserCommandEnvironment, getUserCommandTargets, isMonitored, key, name

Inherited from OSComponent.OSComponent: device, getPrettyLink, isUserCreated, manage_deleteComponent, manage_updateComponent, setUserCreateFlag

Inherited from DeviceComponent.DeviceComponent: filterAutomaticCreation, getAqProperty, getCollectors, getIconPath, getNagiosTemplate, getParentDeviceName, getParentDeviceUrl, getRRDContextData, getStatusString, hostname, setAqProperty

Inherited from Lockable.Lockable: getNextLockableParent, isLockedFromDeletion, isLockedFromUpdates, isUnlocked, lockFromDeletion, lockFromUpdates, lockStatus, lockWarning, sendEventWhenBlocked, setSendEventWhenBlockedFlag, unlock, unsetSendEventWhenBlockedFlag

Inherited from ZenModelRM.ZenModelRM: __init__, changePythonClass, creator, editableDeviceList, findChild, getCreatedTimeString, getDmdKey, getModificationTimeString, getSubObjects, getTreeItems, getZenRootNode, index_object, reindex_all, rename, setTitle, unindex_object, viewName, zmanage_addProperty, zmanage_delObjects, zmanage_delProperties, zmanage_editProperties, zmanage_exportObject, zmanage_importObject, zmanage_importObjects

Inherited from ZenModelBase.ZenModelBase: __call__, __hash__, all_meta_types, aqBaseHasAttr, breadCrumbs, callZenScreen, checkRemotePerm, checkValidId, createHierarchyObj, custPropertyIds, custPropertyMap, getBreadCrumbName, getBreadCrumbUrlPath, getDmd, getDmdObj, getDmdRoot, getHierarchyObj, getIdLink, getNowString, getObjByPath, getPrimaryDmdId, getUnusedId, getZopeObj, helpLink, isLocalName, manage_deleteObjects, prepId, saveCustProperties, todayDate, upToOrganizerBreadCrumbs, urlLink, view, visibleCustPropertyMap, yesterdayDate, zenScreenUrl, zenpathjoin, zenpathsplit, zentinelTabs

Inherited from ZenModelBase.ZenModelBase (private): _selectedTabName

Inherited from ZenRelations.RelationshipManager.RelationshipManager: addRelation, buildRelations, cb_isMoveable, checkRelations, exportXml, exportXmlProperties, exportXmlRelationships, getRelationshipManagerId, getRelationshipNames, getRelationships, manage_addRelation, manage_removeRelation, manage_workspace, moveMeBetweenRels, moveObject, removeRelation

Inherited from ZenRelations.RelationshipManager.RelationshipManager (private): _getCopy, _notifyOfCopyTo, _setObject

Inherited from ZenRelations.PrimaryPathObjectManager.PrimaryPathObjectManager (private): _delObject

Inherited from ZenRelations.RelCopySupport.RelCopyContainer: manage_linkObjects, manage_unlinkObjects

Inherited from ZenRelations.RelCopySupport.RelCopyContainer (private): _checkId, _getRelName, _getSourceObjects, _verifyObjectLink, _verifyObjectPaste

Inherited from OFS.ObjectManager.ObjectManager: __class_init__, __contains__, __delitem__, __getitem__, __iter__, __len__, __nonzero__, __setitem__, filtered_meta_types, get, getSiteManager, hasObject, items, keys, list_imports, manage_FTPlist, manage_FTPstat, manage_afterAdd, manage_afterClone, manage_beforeDelete, manage_delObjects, manage_exportObject, manage_hasId, manage_importObject, objectIds, objectIds_d, objectItems, objectItems_d, objectMap, objectMap_d, objectValues, objectValues_d, setSiteManager, superValues, tpValues, values

Inherited from OFS.ObjectManager.ObjectManager (private): _delOb, _getImportPaths, _getOb, _importObjectFromFile, _setOb, _subobject_permissions

Inherited from OFS.CopySupport.CopyContainer: cb_dataItems, cb_dataValid, manage_CopyContainerAllItems, manage_CopyContainerFirstItem, manage_clone, manage_copyObjects, manage_cutObjects, manage_pasteObjects, manage_renameObject, manage_renameObjects, validClipData

Inherited from OFS.CopySupport.CopyContainer (private): _get_id

Inherited from App.Management.Navigation: manage_zmi_logout

Inherited from ZenRelations.PrimaryPathObjectManager.PrimaryPathManager: getPrimaryId, getPrimaryParent, getPrimaryPath, getPrimaryUrlPath, primaryAq

Inherited from ZenRelations.ZItem.ZItem: __repr__, getId, manage_editedDialog, this, titleOrId, title_and_id, title_or_id, tpURL

Inherited from OFS.CopySupport.CopySource: cb_isCopyable, cb_userHasCopyOrMovePermission

Inherited from OFS.CopySupport.CopySource (private): _canCopy, _postCopy, _setId

Inherited from App.Management.Tabs: filtered_manage_options, tabs_path_default, tabs_path_info

Inherited from webdav.Collection.Collection: DELETE, HEAD, PUT, dav__init, listDAVObjects

Inherited from webdav.Resource.Resource: COPY, LOCK, MKCOL, MOVE, OPTIONS, PROPFIND, PROPPATCH, TRACE, UNLOCK, dav__simpleifhandler, dav__validate, manage_DAVget

Inherited from webdav.Lockable.LockableItem: wl_clearLocks, wl_delLock, wl_getLock, wl_hasLock, wl_isLocked, wl_lockItems, wl_lockTokens, wl_lockValues, wl_lockmapping, wl_setLock

Inherited from webdav.EtagSupport.EtagSupport: http__etag, http__parseMatchList, http__processMatchHeaders, http__refreshEtag

Inherited from OFS.Traversable.Traversable: absolute_url, absolute_url_path, getPhysicalPath, restrictedTraverse, unrestrictedTraverse, virtual_url_path

Inherited from AccessControl.Owned.Owned: changeOwnership, getOwner, getOwnerTuple, getWrappedOwner, manage_changeOwnershipType, manage_fixupOwnershipAfterAdd, manage_takeOwnership, owner_info, userCanTakeOwnership

Inherited from AccessControl.Owned.Owned (private): _deleteOwnershipAfterAdd

Inherited from AccessControl.Role.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_acquiredPermissions, manage_addLocalRoles, manage_changePermissions, manage_defined_roles, manage_delLocalRoles, manage_editRoles, manage_getUserRolesAndPermissions, manage_permission, manage_role, manage_setLocalRoles, permission_settings, permissionsOfRole, possible_permissions, rolesOfPermission, userdefined_roles, users_with_local_role, validRoles, valid_roles, validate_roles

Inherited from AccessControl.Role.RoleManager (private): _addRole, _delRoles, _has_user_defined_role, _setRoles

Inherited from AccessControl.PermissionMapping.RoleManager: manage_getPermissionMapping, manage_setPermissionMapping

Inherited from AccessControl.PermissionMapping.RoleManager (private): _isBeingUsedAsAMethod

Inherited from App.Undo.UndoSupport: get_request_var_or_attr, manage_undo_transactions, undoable_transactions

Inherited from ZenRelations.ZenPropertyManager.ZenPropertyManager: deleteZenProperty, getOverriddenObjects, getProperty, getPropertyType, getZ, hasProperty, isLocal, manage_editProperties, saveZenProperties, setZenProperty, zenPropIsPassword, zenPropertyIds, zenPropertyItems, zenPropertyMap, zenPropertyOptions, zenPropertyPath, zenPropertyString

Inherited from ZenRelations.ZenPropertyManager.ZenPropertyManager (private): _findParentWithProperty, _setPropValue, _setProperty, _updateProperty

Inherited from OFS.History.Historical: manage_afterHistoryCopy, manage_beforeHistoryCopy, manage_change_history, manage_historicalComparison, manage_historyCompare, manage_historyCopy

Inherited from ZenPacker.ZenPacker: addToZenPack, eligiblePacks, findObject

Inherited from DeviceResultInt.DeviceResultInt: getDeviceClassName, getDeviceClassPath, getDeviceIp, getDeviceIpAddress, getDeviceLink, getDeviceMacaddress, getDeviceName, getDeviceUrl, getNonLoopbackIpAddresses, getPingStatus, getPingStatusNumber, getProdState, getSnmpStatus, getSnmpStatusNumber, isResultLockedFromDeletion, isResultLockedFromUpdates, sendEventWhenResultBlocked

Inherited from EventView.EventView: convertEventField, getEventDetail, getEventDetailFromStatusOrHistory, getEventHistory, getEventManager, getEventOwnerList, getEventSummary, getStatusCssClass, getStatusImgSrc, manage_ackBatchEvents, manage_ackEvents, manage_addLogMessage, manage_createEventMap, manage_deleteBatchEvents, manage_deleteEvents, manage_deleteHeartbeat, manage_setEventStates, manage_undeleteBatchEvents, manage_undeleteEvents

Inherited from RRDView.RRDView: cacheRRDValue, fetchRRDValue, fetchRRDValues, fullRRDPath, getDefaultGraphDefs, getGraphDef, getGraphDefUrl, getRRDDataPoint, getRRDDataPoints, getRRDFileName, getRRDNames, getRRDPaths, getRRDSum, getRRDTemplate, getRRDTemplateByName, getRRDTemplateName, getRRDTemplates, getRRDValue, getRRDValues, getThresholdInstances, getThresholds, makeLocalRRDTemplate, removeLocalRRDTemplate, rrdPath, snmpIgnore

Inherited from Commandable.Commandable: compile, doCommandForTarget, getUserCommand, getUserCommandIds, getUserCommands, manage_addUserCommand, manage_deleteUserCommand, manage_doUserCommand, manage_editUserCommand, redirectToUserCommands, write

Inherited from OFS.PropertyManager.PropertyManager: manage_addProperty, manage_changeProperties, manage_changePropertyTypes, manage_delProperties, propdict, propertyDescription, propertyIds, propertyItems, propertyLabel, propertyMap, propertyValues, valid_property_id

Inherited from OFS.PropertyManager.PropertyManager (private): _delPropValue, _delProperty, _propertyMap, _wrapperCheck

Inherited from OFS.ZDOM.ElementWithAttributes: getAttribute, getAttributeNode, getAttributes

Inherited from OFS.ZDOM.Element: getChildNodes, getElementsByTagName, getFirstChild, getLastChild, getNextSibling, getNodeName, getNodeType, getParentNode, getPreviousSibling, getTagName

Inherited from OFS.ZDOM.Node: getNodeValue, getOwnerDocument, hasChildNodes

Class Methods [hide private]

Inherited from ZenRelations.RelationshipManager.RelationshipManager: lookupSchema

Class Variables [hide private]
  __pychecker__ = 'no-override'
  meta_type = 'IpService'
  portal_type = 'IpService'
  protocols = 'tcp', 'udp'
  ipaddresses = []
  discoveryAgent = ""
  port = 0
  protocol = ""
  manageIp = ""
  collectors = 'zenstatus',
  _properties = {'id': 'port', 'type': 'int', 'mode': '', 'sette...
  _relations = Service._relations+(("os", ToOne(ToManyCont, "Pro...
  factory_type_information = {'immediate_view': 'ipServiceDetail...
  security = ClassSecurityInfo()

Inherited from OSComponent.OSComponent: isUserCreatedFlag

Inherited from DeviceComponent.DeviceComponent: default_catalog, event_key, perfmonInstance

Inherited from Lockable.Lockable: modelerLock, sendEventWhenBlockedFlag

Inherited from ManagedEntity.ManagedEntity: monitor, snmpindex

Inherited from ZenModelRM.ZenModelRM: isInTree

Inherited from ZenModelBase.ZenModelBase: index_html, sub_meta_types

Inherited from ZenModelBase.ZenModelBase (private): _zendoc

Inherited from ZenRelations.RelationshipManager.RelationshipManager: manage_main, manage_options

Inherited from ZenRelations.RelationshipManager.RelationshipManager (private): _operation

Inherited from OFS.ObjectManager.ObjectManager: has_order_support, isAnObjectManager, isPrincipiaFolderish, manage_addProduct, manage_importExportForm, manage_index_main, meta_types

Inherited from OFS.ObjectManager.ObjectManager (private): _components, _objects

Inherited from OFS.CopySupport.CopyContainer: manage_renameForm

Inherited from App.Management.Navigation: manage, manage_copyright, manage_form_title, manage_menu, manage_page_footer, manage_page_header, manage_top_frame, manage_zmi_prefs, zope_quick_start

Inherited from ZenRelations.ZItem.ZItem: REQUEST, __allow_access_to_unprotected_subobjects__, __name__, __propsets__, getId__roles__, icon, id, isTopLevelPrincipiaApplicationObject, title

Inherited from ZenRelations.ZItem.ZItem (private): _manage_editedDialog

Inherited from App.Management.Tabs: manage_tabs, manage_workspace__roles__

Inherited from webdav.Collection.Collection: __dav_collection__

Inherited from webdav.Resource.Resource: __dav_resource__, __http_methods__

Inherited from OFS.Traversable.Traversable: getPhysicalRoot

Inherited from AccessControl.Owned.Owned: manage_owner

Inherited from AccessControl.Role.RoleManager: __ac_local_roles__, __ac_roles__, aclAChecked, aclEChecked, aclPChecked, manage_acquiredForm, manage_editLocalRoles, manage_listLocalRoles, manage_permissionForm, manage_reportUserPermissions, manage_roleForm, permissionMappingPossibleValues, selectedRoles, smallRolesWidget

Inherited from AccessControl.Role.RoleManager (private): _normal_manage_access

Inherited from App.Undo.UndoSupport: manage_UndoForm

Inherited from ZenRelations.ZenPropertyManager.ZenPropertyManager: manage_propertiesForm

Inherited from ZenRelations.ZenPropertyManager.ZenPropertyManager (private): _onlystars

Inherited from OFS.History.Historical: HistoricalRevisions, manage_change_history_page

Inherited from OFS.History.Historical (private): _manage_historyComparePage

Inherited from Commandable.Commandable: defaultTimeout

Inherited from OFS.PropertyManager.PropertyManager: manage_propertyTypeForm, propertysheets

Inherited from OFS.PropertyManager.PropertyManager (private): _reserved_names

Method Details [hide private]

monitored(self)

source code 

Return monitored state of ipservice. If service only listens on 127.0.0.1 return false.

Overrides: DeviceComponent.DeviceComponent.monitored

getInstDescription(self)

source code 

Return some text that describes this component. Default is name.

Overrides: DeviceComponent.DeviceComponent.getInstDescription

setServiceClass(self, kwargs)

source code 

Set the service class based on a dict describing the service. Dict keys are be protocol and port

Overrides: Service.Service.setServiceClass

primarySortKey(self)

source code 

Hook for the value used to sort this object. Defaults to self.getId().

Overrides: ZenModelRM.ZenModelRM.primarySortKey
(inherited documentation)

getManageIp(self)

source code 

A service can listen on multiple interfaces on a device, and the interface it listens on may not be the same one that is the manageIp for the device.

Returns: string
IP address to contact the service on
Overrides: DeviceComponent.DeviceComponent.getManageIp

_getManageIp(self)

source code 

Pick an IP out of available choices.

Returns: string
IP address to contact the service on

setManageIp(self, manageIp)

source code 

Manually set the management IP address to check the service status.

Parameters:
  • manageIp (string) - IP address to check the service health

getIpAddresses(self)

source code 

List the IP addresses to which we can contact the service.

Returns: array of strings
list of IP addresses

manage_editService(self, id=None, status=None, ipaddresses=None, manageIp=None, protocol=None, port=None, description=None, monitor=False, severity=5, sendString="", expectRegex="", REQUEST=None)

source code 

Edit a Service from a web page.

Overrides: Service.Service.manage_editService

Class Variable Details [hide private]

_properties

Value:
{'id': 'port', 'type': 'int', 'mode': '', 'setter': 'setPort', 'descri\
ption': "TCP port to check for this service."}, {'id': 'protocol', 'ty\
pe': 'string', 'mode': '', 'setter': 'setProtocol', 'description': "Pr\
otocol (TCP or UPD) used by this service."}, {'id': 'ipaddresses', 'ty\
pe': 'lines', 'mode': '', 'description': "IP addresses that this servi\
ce is listening on."}, {'id': 'discoveryAgent', 'type': 'string', 'mod\
e': '', 'description': "What process was used to discover this service\
."}, {'id': 'manageIp', 'type': 'string', 'mode': '', 'description': "\
...

_relations

Value:
Service._relations+(("os", ToOne(ToManyCont, "Products.ZenModel.Operat\
ingSystem", "ipservices")),)

factory_type_information

Value:
{'immediate_view': 'ipServiceDetail', 'actions':({'id': 'status', 'nam\
e': 'Status', 'action': 'ipServiceDetail', 'permissions':(ZEN_VIEW,)},\
 {'id': 'events', 'name': 'Events', 'action': 'viewEvents', 'permissio\
ns':(ZEN_VIEW,)}, {'id': 'manage', 'name': 'Administration', 'action':\
 'ipServiceManage', 'permissions':("Manage DMD",)}, {'id': 'viewHistor\
y', 'name': 'Modifications', 'action': 'viewHistory', 'permissions':(Z\
EN_VIEW_MODIFICATIONS,)},)},

   Trees       Indices       Help   
Zenoss
Generated by Epydoc 3.0.1 on Wed Jul 14 12:01:31 2010 http://epydoc.sourceforge.net