Package Products :: Package ZenModel :: Module IpService :: Class IpService
[hide private]
[frames] | no frames]

Class IpService

source code

                 object --+                
                          |                
          Lockable.Lockable --+            
                              |            
DeviceComponent.DeviceComponent --+        
                                  |        
    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) 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, title

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

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

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

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

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 Commandable.Commandable: defaultTimeout

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

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",)},)},