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

# Class Service

source code

                     object --+
                              |
              Lockable.Lockable --+
                                  |
    DeviceComponent.DeviceComponent --+
                                      |
        ManagedEntity.ManagedEntity --+
                                      |
                OSComponent.OSComponent --+
                                          |
                Commandable.Commandable --+
                                          |
                             object --+   |
                                      |   |
                ZenPackable.ZenPackable --+
                                          |
                                         Service

Known Subclasses:
  - IpService.IpService
  - , WinService.WinService

Service class

Instance Methods | [hide private]
key(self) Return tuple (manageIp, name) for this service to uniquely id it. | source code
name(self) Return the name of this service. | source code
title(self) Return the name of this service. | source code
monitored(self) Should this service be monitored or not. | source code
isMonitored(self) Returns the same as "monitored" but from the catalog instead of from the service class. | source code
getStatus(self, statClass=None) Return the status number for this component of class statClass. | source code
getSeverities(self) Return a list of tuples with the possible severities | source code
getFailSeverity(self) Return the severity for this service when it fails. | source code
getFailSeverityString(self) Return a string representation of zFailSeverity | source code
setServiceClass(self, kwargs) Set the service class based on a dict describing the service. | source code
getServiceClassLink(self) Return an a link to the service class. | source code
getClassObject(self) Return the ServiceClass for this service. | source code
manage_editService(self, monitor=False, severity=5, msg=None, REQUEST=None) Edit a Service from a web page. | source code
getUserCommandTargets(self) Called by Commandable.doCommand() to ascertain objects on which a UserCommand should be executed. | source code
getUserCommandEnvironment(self) Return the environment to be used when processing a UserCommand | source code
getAqChainForUserCommands(self) Setup the aq chain as appropriate for the execution of a UserCommand | source code
getUrlForUserCommands(self) Return the url where UserCommands are viewed for this object | source code
Inherited from `OSComponent.OSComponent`: `device`, `getPrettyLink`, `isUserCreated`, `manage_deleteComponent`, `manage_updateComponent`, `setUserCreateFlag` Inherited from `DeviceComponent.DeviceComponent`: `filterAutomaticCreation`, `getAqProperty`, `getCollectors`, `getIconPath`, `getInstDescription`, `getManageIp`, `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]
| meta_type = `'Service'`
| portal_type = `'Service'`
| _relations = `OSComponent._relations+ ZenPackable._relations+((`...``
| security = `ClassSecurityInfo()`
Inherited from `OSComponent.OSComponent`: `isUserCreatedFlag` Inherited from `DeviceComponent.DeviceComponent`: `__pychecker__`, `collectors`, `default_catalog`, `event_key`, `perfmonInstance` Inherited from `Lockable.Lockable`: `modelerLock`, `sendEventWhenBlockedFlag` Inherited from `Commandable.Commandable`: `defaultTimeout`

Method Details | [hide private]

### name(self) | source code
Return the name of this service. (short name for net stop/start). Overrides: DeviceComponent.DeviceComponent.name

### title(self) | source code
Return the name of this service. (short name for net stop/start).

### monitored(self) | source code
Should this service be monitored or not. Use ServiceClass aq path. Overrides: DeviceComponent.DeviceComponent.monitored

### getStatus(self, statClass=None) | source code
Return the status number for this component of class statClass. Overrides: DeviceComponent.DeviceComponent.getStatus

### setServiceClass(self, kwargs) | source code
Set the service class based on a dict describing the service. Dict keys are be protocol and port

### getClassObject(self) | source code
Return the ServiceClass for this service. Overrides: DeviceComponent.DeviceComponent.getClassObject

### getUserCommandTargets(self) | source code
Called by Commandable.doCommand() to ascertain objects on which a UserCommand should be executed. Overrides: Commandable.Commandable.getUserCommandTargets

### getUserCommandEnvironment(self) | source code
Return the environment to be used when processing a UserCommand Overrides: Commandable.Commandable.getUserCommandEnvironment

### getAqChainForUserCommands(self) | source code
Setup the aq chain as appropriate for the execution of a UserCommand Overrides: Commandable.Commandable.getAqChainForUserCommands

### getUrlForUserCommands(self) | source code
Return the url where UserCommands are viewed for this object Overrides: Commandable.Commandable.getUrlForUserCommands

Class Variable Details | [hide private]

  ### _relations Value:
      OSComponent._relations+ ZenPackable._relations+(("serviceclass", ToOne
      (ToMany, "Products.ZenModel.ServiceClass", "instances")), ('userComman
      ds', ToManyCont(ToOne, 'Products.ZenModel.UserCommand', 'commandable')
      ),)