Package ZenModel :: Module DeviceOrganizer :: Class DeviceOrganizer

Class DeviceOrganizer

                                                   object --+            
                                                            |            
                                    ZenModelBase.ZenModelBase --+        
                                                                |        
Products.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

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)
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, 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, getBreadCrumbUrlPath, getDmd, getDmdObj, getDmdRoot, getHierarchyObj, getIdLink, getNowString, getObjByPath, getPrimaryDmdId, getUnusedId, getZ, getZopeObj, helpLink, isLocalName, manage_deleteObjects, prepId, saveCustProperties, todayDate, view, visibleCustPropertyMap, yesterdayDate, zenScreenUrl, zenpathjoin, zenpathsplit, zentinelTabs

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: convertEventField, getEventDetail, getEventDetailFromStatusOrHistory, getEventHistory, getEventManager, getEventOwnerList, getEventSummary, getStatus, getStatusCssClass, getStatusImgSrc, getStatusString, manage_ackBatchEvents, manage_ackEvents, manage_addLogMessage, manage_createEventMap, manage_deleteBatchEvents, manage_deleteEvents, manage_deleteHeartbeat, manage_setEventStates, manage_undeleteBatchEvents, manage_undeleteEvents

Inherited from object: __delattr__, __getattribute__, __new__, __reduce__, __reduce_ex__, __repr__, __setattr__, __str__

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 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 OFS.History.Historical: HistoricalRevisions, __ac_permissions__, manage_change_history_page, manage_options

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

Inherited from Commandable.Commandable: defaultTimeout

Properties

[hide private]

Inherited from object: __class__

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)

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')),)