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

Class DeviceOrganizer

source code

                                                        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 --+       |       |        
                                                     |       |       |        
                         AccessControl.Owned.Owned --+       |       |        
                                                     |       |       |        
                              ZenRelations.ZItem.ZItem --+   |       |        
                                                         |   |       |        
                                  Acquisition.Implicit --+   |       |        
                                                         |   |       |        
                        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 --+    
                                                                         |    
                                                            object --+   |    
                                                                     |   |    
                                                   EventView.EventView --+    
                                                                         |    
                                                       Organizer.Organizer --+
                                                                             |
                                       DeviceManagerBase.DeviceManagerBase --+
                                                                             |
                                                   Commandable.Commandable --+
                                                                             |
                                                   ZenMenuable.ZenMenuable --+
                                                                             |
                               MaintenanceWindowable.MaintenanceWindowable --+
                                                                             |
                             AdministrativeRoleable.AdministrativeRoleable --+
                                                                             |
                                                                            DeviceOrganizer
Known Subclasses:

DeviceOrganizer is the base class for device organizers. It has lots of methods for rolling up device statistics and information.

Instance Methods [hide private]
list
getSubDevices(self, devfilter=None)
Get all the devices under an instance of a DeviceOrganizer
source code
 
getSubDevicesGen(self)
get all the devices under and instance of a DeviceGroup
source code
 
getSubDevices_recursive(self, devfilter=None, devrel="devices") source code
 
getSubDevicesGen_recursive(self, devrel="devices")
get all the devices under and instance of a DeviceGroup
source code
 
getSubDevicesGenTest(self, devrel="devices")
get all the devices under and instance of a DeviceGroup
source code
 
getMonitoredComponents(self)
Return monitored components for devices within this DeviceOrganizer.
source code
 
getAllCounts(self, devrel="devices")
Count all devices within a device group and get the ping and snmp counts as well
source code
 
countDevices(self, devrel="devices")
count all devices with in a device group
source code
 
pingStatus(self, devrel="devices")
aggrigate ping status for all devices in this group and below
source code
 
snmpStatus(self, devrel="devices")
aggrigate snmp status for all devices in this group and below
source code
 
_buildDeviceList(self, deviceNames)
Build a device list for set methods
source code
 
deviceClassMoveTargets(self)
Return list of all organizers excluding our self.
source code
 
moveDevicesToClass(self, moveTarget, deviceNames=None, REQUEST=None)
Move Devices from one DeviceClass to Another
source code
 
_handleOrganizerCall(self, arg=None, deviceNames=None, isOrganizer=False, REQUEST=None, deviceMethod=None)
Handle the many many methods that simply call one method on device differently
source code
 
_buildReturnMessage(self, title, message, paths=None, checkPaths=False)
build the standard return message for the various set methods
source code
 
setProdState(self, state, deviceNames=None, isOrganizer=False, REQUEST=None)
Set production state of all devices in this Organizer.
source code
 
setPriority(self, priority, deviceNames=None, isOrganizer=False, REQUEST=None)
Set prioirty of all devices in this Organizer.
source code
 
setPerformanceMonitor(self, performanceMonitor=None, deviceNames=None, isOrganizer=False, REQUEST=None)
Provide a method to set performance monitor from any organizer
source code
 
setGroups(self, groupPaths=None, deviceNames=None, isOrganizer=False, REQUEST=None)
Provide a method to set device groups from any organizer
source code
 
setSystems(self, systemPaths=None, deviceNames=None, isOrganizer=False, REQUEST=None)
Provide a method to set device systems from any organizer
source code
 
setLocation(self, locationPath="", deviceNames=None, isOrganizer=False, REQUEST=None)
Provide a method to set device location from any organizer
source code
 
unlockDevices(self, deviceNames=None, isOrganizer=False, REQUEST=None)
Unlock devices
source code
 
lockDevicesFromDeletion(self, deviceNames=None, sendEventWhenBlocked=None, isOrganizer=False, REQUEST=None)
Lock devices from being deleted
source code
 
lockDevicesFromUpdates(self, deviceNames=None, sendEventWhenBlocked=None, isOrganizer=False, REQUEST=None)
Lock devices from being deleted or updated
source code
 
index_object(self, idxs=None)
No action.
source code
 
unindex_object(self)
No action.
source code
 
manage_addAdministrativeRole(self, newId, REQUEST=None)
Overrides AdministrativeRoleable.manage_addAdministrativeRole Adds an administrator to this DeviceOrganizer
source code
 
manage_editAdministrativeRoles(self, ids=(), role=(), level=(), REQUEST=None)
Overrides AdministrativeRoleable.manage_editAdministrativeRoles Edit the administrators to this DeviceOrganizer
source code
 
manage_deleteAdministrativeRole(self, delids=(), REQUEST=None)
Overrides AdministrativeRoleable.manage_deleteAdministrativeRole Deletes administrators to this DeviceOrganizer
source code
 
manage_snmpCommunity(self, REQUEST=None)
reset Community on all devices in this Organizer.
source code
 
setManageIp(self, REQUEST=None)
reset ip on all devices in this Organizer.
source code
 
collectDevice(self, REQUEST=None)
model all devices in this Organizer.
source code
 
_status(self, type, devrel="devices")
build status info for device in this device group
source code
 
statusColor(self, status)
colors for status fields for device groups
source code
 
getUserCommandTargets(self)
Called by Commandable.doCommand() to ascertain objects on which a UserCommand should be executed.
source code
 
getUrlForUserCommands(self)
Return url for page which manages user commands
source code
 
getLinks(self, recursive=True)
Return all Links on all interfaces on all Devices in this Organizer
source code
string
getIconPath(self)
Override the zProperty icon path and return a folder
source code
 
getPrettyLink(self, noicon=False, shortDesc=False)
Gets a link to this object, plus an icon
source code

Inherited from Organizer.Organizer: __init__, childIds, childMoveTargets, children, countChildren, createOrganizer, deviceMoveTargets, exportXmlHook, getChildMoveTarget, getDmdKey, getOrganizer, getOrganizerName, getOrganizerNames, getSubInstanceIds, getSubInstances, getSubInstancesGen, getSubOrganizers, manage_addOrganizer, manage_deleteOrganizer, manage_deleteOrganizers, moveOrganizer, urlLink

Inherited from Organizer.Organizer (private): _getCatalog

Inherited from ZenModelRM.ZenModelRM: changePythonClass, creator, editableDeviceList, findChild, getCreatedTimeString, getModificationTimeString, getSubObjects, getTreeItems, getZenRootNode, primarySortKey, reindex_all, rename, setTitle, 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, 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.RelCopySupport.RelCopyContainer: manage_linkObjects, manage_unlinkObjects

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 App.Undo.UndoSupport: get_request_var_or_attr, manage_undo_transactions, undoable_transactions

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

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 EventView.EventView: getEventManager, getEventSeveritiesCount, getEventSummary, getStatus, getStatusCssClass, getStatusImgSrc, getStatusString, getUUID, getWorstEventSeverity, manage_ackEvents, manage_deleteEvents, manage_undeleteEvents

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

Inherited from DeviceManagerBase.DeviceManagerBase: getDevices, removeDevices

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

Inherited from ZenMenuable.ZenMenuable: buildMenus, getMenus, manage_addItemsToZenMenu, manage_addZenMenu, manage_addZenMenuItem, manage_deleteZenMenu, manage_deleteZenMenuItem, manage_saveMenuItemOrdering

Inherited from MaintenanceWindowable.MaintenanceWindowable: getMaintenanceWindows, manage_addMaintenanceWindow, manage_deleteMaintenanceWindow

Inherited from AdministrativeRoleable.AdministrativeRoleable: getAdministrativeRoles, manage_listAdministrativeRoles, setAdminLocalRoles

Class Methods [hide private]

Inherited from ZenRelations.RelationshipManager.RelationshipManager: lookupSchema

Class Variables [hide private]
  security = ClassSecurityInfo()
  factory_type_information = {'immediate_view': 'deviceOrganizer...
  _relations = Organizer._relations+(("maintenanceWindows", ToMa...

Inherited from Organizer.Organizer (private): _properties

Inherited from ZenModelRM.ZenModelRM: default_catalog, isInTree, meta_type

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 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 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 App.Undo.UndoSupport: manage_UndoForm

Inherited from ZenRelations.ZenPropertyManager.ZenPropertyManager: __pychecker__, manage_propertiesForm

Inherited from OFS.History.Historical: HistoricalRevisions, manage_change_history_page

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

Inherited from OFS.PropertyManager.PropertyManager: manage_propertyTypeForm, propertysheets

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

Inherited from Commandable.Commandable: defaultTimeout

Method Details [hide private]

getSubDevices(self, devfilter=None)

source code 

Get all the devices under an instance of a DeviceOrganizer

Parameters:
  • devfilter (function) - Filter function applied to returned list
Returns: list
Devices

index_object(self, idxs=None)

source code 

No action. Index of subdevices will happen in manage_addAdministrativeRole

Overrides: ZenModelRM.ZenModelRM.index_object

unindex_object(self)

source code 

No action. Unindex of subdevices will happen in manage_deleteAdministrativeRole

Overrides: ZenModelRM.ZenModelRM.unindex_object

manage_addAdministrativeRole(self, newId, REQUEST=None)

source code 

Overrides AdministrativeRoleable.manage_addAdministrativeRole Adds an administrator to this DeviceOrganizer

Parameters:
  • userid (string) - User to make an administrator of this Organizer
Overrides: AdministrativeRoleable.AdministrativeRoleable.manage_addAdministrativeRole

manage_editAdministrativeRoles(self, ids=(), role=(), level=(), REQUEST=None)

source code 

Overrides AdministrativeRoleable.manage_editAdministrativeRoles Edit the administrators to this DeviceOrganizer

Overrides: AdministrativeRoleable.AdministrativeRoleable.manage_editAdministrativeRoles

manage_deleteAdministrativeRole(self, delids=(), REQUEST=None)

source code 

Overrides AdministrativeRoleable.manage_deleteAdministrativeRole Deletes administrators to this DeviceOrganizer

Parameters:
  • delids (tuple of strings) - Users to delete from this Organizer
Overrides: AdministrativeRoleable.AdministrativeRoleable.manage_deleteAdministrativeRole

getUserCommandTargets(self)

source code 

Called by Commandable.doCommand() to ascertain objects on which a UserCommand should be executed.

Overrides: Commandable.Commandable.getUserCommandTargets

getUrlForUserCommands(self)

source code 

Return url for page which manages user commands

Overrides: Commandable.Commandable.getUrlForUserCommands
(inherited documentation)

getIconPath(self)

source code 

Override the zProperty icon path and return a folder

Returns: string
Path to icon
Overrides: ZenModelBase.ZenModelBase.getIconPath

Class Variable Details [hide private]

factory_type_information

Value:
{'immediate_view': 'deviceOrganizerStatus', 'actions':({'id': 'status'\
, 'name': 'Status', 'action': 'deviceOrganizerStatus', 'permissions':(\
ZEN_VIEW,)}, {'id': 'events', 'name': 'Events', 'action': 'viewEvents'\
, 'permissions':(ZEN_VIEW,)}, {'id': 'manage', 'name': 'Administration\
', 'action': 'deviceOrganizerManage', 'permissions':(ZEN_MANAGE_DMD,)}\
,)},

_relations

Value:
Organizer._relations+(("maintenanceWindows", ToManyCont(ToOne, "Produc\
ts.ZenModel.MaintenanceWindow", "productionState")), ("adminRoles", To\
ManyCont(ToOne, "Products.ZenModel.AdministrativeRole", "managedObject\
")), ('userCommands', ToManyCont(ToOne, 'Products.ZenModel.UserCommand\
', 'commandable')), ('zenMenus', ToManyCont(ToOne, 'Products.ZenModel.\
ZenMenu', 'menuable')),)