datamodel.py File Reference

Namespaces
	datamodel

Functions
def	datamodel.QueryNodeObjects (nbpath_schema, query)
def	datamodel.QueryDeviceObjects (query)
	query device object More...
def	datamodel.QueryDeviceIds (query)
	query device id list by query More...
def	datamodel.GetDevIdsByNames (devNames)
	query device id list by device name More...
def	datamodel.SetDeviceObject (device, deviceObj)
	set device object More...
def	datamodel.AddDeviceObject (deviceObj)
def	datamodel.GetDeviceObject (device)
	Get device object by device name. More...
def	datamodel.GetDeviceObjectById (devId)
	Get device object by device id. More...
def	datamodel.GetDeviceNameFromIp (strIp)
	Get device name by IP(interface ips.ip) More...
def	datamodel.SetDeviceProperty (property_name, device_name, value)
	Set device property. More...
def	datamodel.GetDeviceProperty (property_name, device_name)
	Get device property. More...
def	datamodel.QueryInterfaceIds (query, intf_type)
	Get interface id list by intf type. More...
def	datamodel.QueryInterfaceObjects (query, intf_type)
	Get interface id list by intf type. More...
def	datamodel.SetInterfaceObject (device, intf_name, intf_type, intf_object, get_new=False)
	Set interface object. More...
def	datamodel.GetInterfaceObject (device, intf_name, intf_type, get_new=False)
	Get interface object by device name, interface name. More...
def	datamodel.GetInterfaceObjectById (intf_id, intf_type, get_new=False)
	Get interface object by interface id. More...
def	datamodel.GetInterfaceIdsByDeviceName (device, intf_type)
	Get interface id list by device name. More...
def	datamodel.GetDeviceInterfaceId (device, phantom_interface_name, phantom_interface_type, get_new=False)
	Get interface id by device name, interface name, interface type. More...
def	datamodel.GetPhantomInterfaceIds (device, device_interface_name, phantom_interface_type)
	Get phantom interface id by device name, interface name, interface type. More...
def	datamodel.GetInterfaceIdsByType (intf_type)
	Get interface id list by interface type. More...
def	datamodel.SetInterfaceProperty (property_name, device, intf_name, intf_type, value, get_new=False)
	Set interface attribute. More...
def	datamodel.SetInterfacePropertyById (property_name, intf_id, intf_type, value, get_new=False)
	Set interface attribute by Id. More...
def	datamodel.GetInterfaceProperty (property_name, device, intf_name, intf_type)
	Get interface attribute. More...
def	datamodel.AddPhantomInterface (device_name, interface_name, interface_type, belongs_to_topology_type, get_new=False)
	Add phantom interface. More...
def	datamodel.RemovePhantomInterface (device_name, interface_name, interface_type)
	Remove phantom interface. More...
def	datamodel.UpdateOnePhantomInterface (device_name, interface_type, interface_object, get_new=False)
	Update one interface of one device. More...
def	datamodel.UpdatePhantomInterfaces (device_name, interface_type, interface_objects)
	Update all interface of one device. More...
def	datamodel.ClearPhantomInterface (device_name, interface_type)
	delete all the intf of the device More...
def	datamodel.GetInterfaceShortName (device_name, interface_name)
	get interface short name More...
def	datamodel.CompleteInterfaceName (device_name, interface_name)
	get interface full name More...
def	datamodel.SetModuleObject (device_name, module_name, module_object)
	update device's module object by module name. More...
def	datamodel.GetModuleObject (device_name, module_name)
	get device's module object by module name. More...
def	datamodel.SetModuleProperty (property_name, device_name, module_name, value)
	Set module attribute. More...
def	datamodel.GetModuleProperty (property_name, device_name, module_name)
	Get module attribute. More...
def	datamodel.GetMemberInterfaceIdsBelong2Channel (device, intf)
	get member interface ids Belong2Channel More...
def	datamodel.SetInternetCloud (cloud_name, value)
	set internet cloud object. More...
def	datamodel.GetInternetCloud (cloud_name)
	get internet cloud. More...
def	datamodel.SetInternetCloudProperty (property_name, cloud_name, value)
	set internet cloud property. More...
def	datamodel.GetInternetCloudProperty (property_name, cloud_name)
	get internet cloud property. More...
def	datamodel.SetCloudStaticProperty (cloud_name, prop)
def	datamodel.RemoveCloudStaticProperty (cloud_name, cloud_interface)
def	datamodel.SetInternetCloudIntfList (cloudName, boudaryInterfaceList)
	set internet cloud interface list. More...
def	datamodel.RemoveInternetCloudInterface (cloudName, interfaceName)
def	datamodel.ClearInternetCloudIntfList (cloudName)
	delete all the intf of the internet cloud ,from v2.1 (2019-03-04) More...
def	datamodel.GetInternetCloudIntfList (cloudName)
	get internet cloud interface list. More...
def	datamodel.SetMPLSCloudProperty (propertyName, cloudName, value)
	set mpls cloud property. More...
def	datamodel.GetMPLSCloudProperty (propertyName, cloudName)
	get mpls cloud property. More...
def	datamodel.SetMPLSCloud (cloudName, CEList, dynamicCondition, excludeCEList)
	set MPLS cloud datas. More...
def	datamodel.GetMPLSCloud (cloudName)
	get the MPLS cloud define. More...
def	datamodel.SetMPLSCloudCEObjects (cloudName, ceNbrObjs, flag)
	add or update Mpls CE . More...
def	datamodel.SetMPLSCloudStaticCE (cloudName, iPofPEinterface, cEDevice, cEInterface, VRF, routingProtocol, VPN)
def	datamodel.GetMPLSCloudStaticCEList (cloudName, ceName=None, ceIntfName=None)
	get the static CE list of MPLS cloud. More...
def	datamodel.SetMPLSCloudDynamicFilter (cloudName, filterCondition)
	set the dynamic CE filter. More...
def	datamodel.GetMPLSCloudDynamicCEList (cloudName, ceName=None, ceIntfName=None)
	get the dynamic CE list of MPLS cloud. More...
def	datamodel.SetMPLSCloudExcludeCEList (cloudName, CEList)
	add or update Mpls Excluce CE List. More...
def	datamodel.GetMPLSCloudExcludeCEList (cloudName, ceName=None, ceIntfName=None)
def	datamodel.DeleteMPLSCloud (cloudName)
def	datamodel.GetMacDevicesByMac (mac)
	get mac device by mac More...
def	datamodel.DeleteMacDeviceByMac (mac)
	delete mac device by mac More...
def	datamodel.DeleteMacDeviceById (id)
	delete mac device by id More...
def	datamodel.GetSchemaType (schema_name)
	get schema type by schema name More...
def	datamodel.SetDeviceCredential (device_name, username, password, privilege_username, privilege_password, access_mode=0, port=0)
	Network settings APIs - SetDeviceCredential. More...
def	datamodel.GetProxyServerStatus (fsId)
	Network settings APIs - GetProxyServerStatus. More...
def	datamodel.SetProxyServerOfDevice (device_name, fsId)
	Network settings APIs - SetProxyServerOfDevice. More...
def	datamodel.GetDeviceSetting (device)
	Get device setting. More...
def	datamodel.SetDeviceSetting (device_setting_object)
	Set device setting. More...
def	datamodel.GetAllPhantomInterfaceTypes ()
	get all phantom interface types More...
def	datamodel.FindVendorByMAC (mac)
	find vendor by mac More...
def	datamodel.GetVendorModel (sysoid)
	get vendor model More...
def	datamodel.GetCurrentDomainInfo ()
	get domain info More...
def	datamodel.GetDeviceMACInfo (filter_list)
	get mac info More...
def	datamodel.GetDeviceSiteName (device)
	get device site name More...
def	datamodel.GetDeviceSiteFullPath (device)
	get device site full path More...
def	datamodel.GetDeviceIdsFromSite (site_path, include_child=False)
	get device ids from site More...
def	datamodel.AddDevicesToSite (site_path, device_ids)
	add devices to site More...
def	datamodel.RemoveDevicersFromSite (siteh_path, device_ids)
def	datamodel.ClearDevicesInSite (siteh_path)
def	datamodel.GetSiteProperty (property_name, site_path)
	get site property More...
def	datamodel.SetSiteProperty (property_name, site_path, value)
	set site property More...
def	datamodel.GetAllSitePath ()
	Get all site paths. More...
def	datamodel.CreateDeviceGroup (device_group_name, device_group_type)
	create device group More...
def	datamodel.AddDeviceToDeviceGroup (device, device_group_name, isStatic=True, deviceGroupType=0)
	add device to device group More...
def	datamodel.AddDevicesToDeviceGroup (devices, device_group_name, isStatic=True, deviceGroupType=0)
	add devices to device group More...
def	datamodel.RemoveDeviceFromDeviceGroup (device, device_group_name, deviceGroupType=0)
	remove device from device group More...
def	datamodel.ClearDevicesInDeviceGroup (device_group_name, deviceGroupType=0)
	clear device from device group More...
def	datamodel.GetDeviceIdsFromDeviceGroup (device_group_name, type=-1)
	get device ids from device group More...
def	datamodel.GetCurrentMapId ()
	get current map id More...
def	datamodel.GetCurrentMapPageId ()
	get current map page id More...
def	datamodel.GetCurrentRunbookID ()
	get current runbook id More...
def	datamodel.GetRunbookTemplete (runbook_templete_path)
	get runbook templete by path More...
def	datamodel.GetQappInfo (qapp_path)
	get qapp content by path More...
def	datamodel.GetDataViewTemplete (dvt_path)
	get dvt by path More...
def	datamodel.SaveDataToDB (db, collection, value)
def	datamodel.QueryDataFromDB (db, collection, json_value)
def	datamodel.GetDriverIdBySysOID (sysObjectID)
def	datamodel.GetDriverIdByVendorModel (vendor, model)
	get driver id from vendor model More...
def	datamodel.AddNDTItem (devNameExp, isRegex, ipAddrRange, driverId, subType)
	add Network Definition More...
def	datamodel.GetNDTItems ()
	return all NDT Items More...
def	datamodel.SetNDTItem (ndtItem)
	set NDT Item More...
def	datamodel.AddDonotScanSubnet (subnet, desc=None)
	AddDonotScanSubnet. More...
def	datamodel.AddDonotScanDeviceSubType (subtype, desc=None)
	AddDonotScanDeviceSubType. More...
def	datamodel.GetDonotScan ()
	GetDonotScan. More...
def	datamodel.GetUnknowSNMPSysObjectId (rtnFileds=None)
	GetUnknowSNMPSysObjectId. More...
def	datamodel.GetUnclassifiedNetworkDevice (rtnFileds=None)
	GetUnclassifiedNetworkDevice. More...
def	datamodel.GetSNMPDevices (rtnFileds=None, device_name_list=None)
	GetSNMPDevices. More...
def	datamodel.GetMissDevice (rtnFileds=None, device_name_list=None)
	GetMissDevice. More...
def	datamodel.DelMissDevice (name)
	Delete Missdevice in current domain. More...
def	datamodel.get_unknown_ips ()
def	datamodel.GetDiscoverInput (datasourceId, isTaskId=None)
	GetDiscoverInput. More...
def	datamodel.GetNewDevice (rtnFileds=None)
	GetNewDevice. More...
def	datamodel.GetBenchmarkIdByName (sourceName)
	GetBenchmarkIdByName. More...
def	datamodel.GetBenchmarkExcludeDeviceGroup (sourceId)
	GetBenchmarkExcludeDeviceGroup. More...
def	datamodel.SetBenchmarkExcludeDeviceGroup (sourceId, devicegroups)
	SetBenchmarkExcludeDeviceGroup. More...
def	datamodel.DisableBenchmarkOneProcess (sourceId, processName)
	DisableBenchmarkOneProcess. More...
def	datamodel.GetAllDeviceLiveCostInBMTask (sourceId)
	GetAllDeviceLiveCostInBMTask. More...
def	datamodel.GetBenchmarkTargetDevices (sourceId)
	Get Benchmark target devices. More...
def	datamodel.GetBenchmarkAPIServerIDList (sourceId)
	Get SDN Api Server id of Benchmark task. More...
def	datamodel.GetSDNNodesByServerID (serverId)
	Get Benchmark SDN scope ranges. More...
def	datamodel.ValidateDictElement (key, dictIns, valueType)
def	datamodel.ValidateEmailJson (emailInfo)
def	datamodel.SendEmail (emailInfo)
	Plugin prepare information for email More...
def	datamodel.DeleteDevices (device_names)
	delete devices More...
def	datamodel.GetAllDuplicateIp ()
	More...
def	datamodel.SetPyLastError (error, error_number=-1)
	SetLastError. More...
def	datamodel.GetPyLastError ()
def	datamodel.GetPyLastErrorCode ()
def	datamodel.ClearPyLastError ()
def	datamodel.SubmitChildTask (task_name, task_param, wait_seconds=0)
	submit one child task to RMAgent More...
def	datamodel.SubmitHostNameChangeChildTask ()
def	datamodel.GetHostnameChangeList (jobId)
	get host name change list More...
def	datamodel.UpsertHostnameChangeList (host_name_list)
	update host name change list More...
def	datamodel.KeepLastChangeDevice (snInfoList)
	keep last change device More...
def	datamodel.ExcuteSharedTuneDevice (condition, option)
	Excute Shared Tune Device. More...
def	datamodel.ExcuteTuneOneDevice (devId)
	Excute Shared Tune one Device. More...
def	datamodel.ExcutePrivateTuneDevices (condition)
	Excute Private Tune Devices. More...
def	datamodel.ExcutePrivateTuneOneDevice (devId)
	Excute Private Tune one Device. More...
def	datamodel.GetTuneDeviceResultByDevIds (devIds)
	Get Shared Tune Device Reuslt by device ids. More...
def	datamodel.GetPrivateTuneDeviceResultByDevIds (devIds)
	Get Pravite Tune Device Reuslt by device ids. More...
def	datamodel.GetProfileClass (device)
def	datamodel.GetTuneDeviceResultByDevId (devId)
	Get Shared Tune Device Reuslt by device id. More...
def	datamodel.TriggerEventTemplate (message, eventTemplateName=None)
	trigger event templete More...
def	datamodel.AddOrUpdateCommandTemplate (name, command, scope, description, type=0)
	Add or Update command template. More...
def	datamodel.UpdateLayoutTagForDevs (devNames, tagNames)
	Update LayoutTag For Devices. More...
def	datamodel.DeleteLayoutTagForDevs (devNames, tagNames)
	Delete LayoutTag For Devices. More...
def	datamodel.DeleteOpenTopoInterfaces (intfIds)
	Delete documents from OpenTopoInterface Collections. More...
def	datamodel.RecreateDeviceOpenTopoDETable (devId)
	Rebuild OpenTopoArpTable, OpenTopoMacTable, OpenTopoNdpTable and OpenTopoL3NeighborTable by DataEngine data. More...
def	datamodel.GetDevicesLearnedSpecifiedMac (mac)
	Get Devices which had Learned Specified Mac. More...
def	datamodel.CleanOpenTopoNeighborPairTable (query)
	Clean OpenTopoNeighborPairTable by query condition. More...

Variables
	datamodel.str_stack = traceback.format_exc()
string	datamodel.MPLS_DYNYMIC_FILTER_KEY = 'deviceFilter'
string	datamodel.MPLS_CE_ACCESS_PNT_KEY = 'mpls_accessPnt'
string	datamodel.MPLS_EXCLUDE_PNT_KEY = 'exclude_accessPnt'
int	datamodel.CLOUD_STATIC_TYPE = 0