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

Class DeviceComponent

source code

       object --+    
                |    
Lockable.Lockable --+
                    |
                   DeviceComponent
Known Subclasses:

DeviceComponent is a mix-in class for all components of a device. These include LogicalComponent, Software, and Hardware.

Instance Methods [hide private]
 
getParentDeviceName(self)
Return the name of this component's device
source code
 
hostname(self)
Return the name of this component's device
source code
 
getParentDeviceTitle(self)
Return the title of this component's device
source code
 
getParentDeviceUrl(self)
Return the url of this component's device
source code
 
name(self)
Return the name of this component.
source code
 
monitored(self)
Return the monitored status of this component.
source code
 
getCollectors(self)
Return list of collectors that want to monitor this component
source code
 
getInstDescription(self)
Return some text that describes this component.
source code
 
getStatus(self, statClass=None)
Return the status number for this component of class statClass.
source code
 
getStatusString(self, statClass=None)
Return a text representation of this component's status
source code
 
getManageIp(self)
Return the manageIP of the device of this component.
source code
 
getNagiosTemplate(self, unused=None) source code
 
getAqProperty(self, prop)
Get a property from ourself if it exsits then try serviceclass path.
source code
 
setAqProperty(self, prop, value, type)
Set a local prop if nessesaary on this service.
source code
 
getClassObject(self)
If you are going to use acquisition up different class path override this.
source code
 
getIconPath(self)
Get the icon for this component.
source code
 
getRRDContextData(self, context) source code
 
filterAutomaticCreation(self)
Test if automatic creation (and anchoring into a model) is appropriate for this object.
source code
generator
getSubComponentsNoIndexGen(self)
Recursively gets every sub component for this component.
source code

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

Class Variables [hide private]
  __pychecker__ = 'no-override'
  event_key = "Component"
  default_catalog = "componentSearch"
  collectors = 'zenperfsnmp', 'zencommand', 'zenwinperf', 'zenping'
  security = ClassSecurityInfo()
  perfmonInstance = None

Inherited from Lockable.Lockable: modelerLock, sendEventWhenBlockedFlag

Method Details [hide private]

name(self)

source code 

Return the name of this component. Default is id.

monitored(self)

source code 

Return the monitored status of this component. Default is False.

getInstDescription(self)

source code 

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

filterAutomaticCreation(self)

source code 

Test if automatic creation (and anchoring into a model) is appropriate for this object. Lets us ignore detectable gunk that's not very interesting to model, like most processes, and loopback network devices, CDROM file systems, etc.

Returns False if the object should not be added.

The object will have its full acquisition path, but will not have been added to the database.

getSubComponentsNoIndexGen(self)

source code 

Recursively gets every sub component for this component. We use the slow method of just looking at every object underneath this object and yielding those that are DeviceComponents.

NOTE: this does not use a catalog and is used only to index a catalog. It is painfully inefficient

Returns: generator
Every subcomponent directly under this component