netbrain.sysapi.datamodel Namespace Reference

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

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

Function Documentation

AddDeviceObject()

def netbrain.sysapi.datamodel.AddDeviceObject

(

deviceObj

)

AddDevicesToDeviceGroup()

def netbrain.sysapi.datamodel.AddDevicesToDeviceGroup	(		devices,
			device_group_name,
			isStatic = True,
			deviceGroupType = 0
	)

add devices to device group

Note

If device group is private, this func need opUserID (only support qapp, path, sdn, plugin)

Parameters

devices	(list) devices name
device_group_name	(string) device group name
isStatic	(bool) is isStatic
deviceGroupType	(int) device group type (default 0)- Public = 0, Private = 1

Returns

True or False

AddDevicesToSite()

def netbrain.sysapi.datamodel.AddDevicesToSite	(		site_path,
			device_ids
	)

add devices to site

Parameters

site_path	(string) site full path
device_ids	(list) device id lists

Returns

bool

True or False

AddDeviceToDeviceGroup()

def netbrain.sysapi.datamodel.AddDeviceToDeviceGroup	(		device,
			device_group_name,
			isStatic = True,
			deviceGroupType = 0
	)

add device to device group

Note

If device group is private, this func need opUserID (only support qapp, path, sdn, plugin)

Parameters

device	(string) device name
device_group_name	(string) device group name
isStatic	(bool) is isStatic
deviceGroupType	(int) device group type (default 0)- Public = 0, Private = 1

Returns

True or False

AddDonotScanDeviceSubType()

def netbrain.sysapi.datamodel.AddDonotScanDeviceSubType	(		subtype,
			desc = None
	)

AddDonotScanDeviceSubType.

Parameters

subtype	(int) devicetype id
desc	(string) description of the subtype

Returns

bool True or False

AddDonotScanSubnet()

def netbrain.sysapi.datamodel.AddDonotScanSubnet	(		subnet,
			desc = None
	)

AddDonotScanSubnet.

Parameters

subnet	(string) format:ip/mask like 10.10.0.50/24
desc	(string) description of the subnet

Returns

bool True or False

AddNDTItem()

def netbrain.sysapi.datamodel.AddNDTItem	(		devNameExp,
			isRegex,
			ipAddrRange,
			driverId,
			subType
	)

add Network Definition

Parameters

devNameExp	device name expression
isRegex	devNameExp is regex or not.
ipAddrRange	ip
driverId	driver id
subType	device sub type

AddOrUpdateCommandTemplate()

def netbrain.sysapi.datamodel.AddOrUpdateCommandTemplate	(		name,
			command,
			scope,
			description,
			type = 0
	)

Add or Update command template.

Parameters

name	command template name
command	command
scope	scope command scope - 0 - Public 2 - Pravite
description	description
type	command type - 0 - ConfigTemplate
description	description

Returns

True or False

AddPhantomInterface()

def netbrain.sysapi.datamodel.AddPhantomInterface	(		device_name,
			interface_name,
			interface_type,
			belongs_to_topology_type,
			get_new = False
	)

Add phantom interface.

Parameters

device_name	(string) device name
interface_name	(string) interface name
interface_type	(string) interface type
belongs_to_topology_type	(string) belongs to topo type
get_new	(bool) Whether to use new data(When the interface data is modified in your script, it needs to be set to true in order to obtain the updated data)

Returns

True or False

CleanOpenTopoNeighborPairTable()

def netbrain.sysapi.datamodel.CleanOpenTopoNeighborPairTable

(

query

)

Clean OpenTopoNeighborPairTable by query condition.

Parameters

query

query condition

Returns

True or False

ClearDevicesInDeviceGroup()

def netbrain.sysapi.datamodel.ClearDevicesInDeviceGroup	(		device_group_name,
			deviceGroupType = 0
	)

clear device from device group

Note

If device group is private, this func need opUserID (only support qapp, path, sdn, plugin)

Parameters

device_group_name	(string) device group name
deviceGroupType	(int) device group type (default 0)- Public = 0, Private = 1

Returns

True or False

ClearDevicesInSite()

def netbrain.sysapi.datamodel.ClearDevicesInSite

(

siteh_path

)

ClearInternetCloudIntfList()

def netbrain.sysapi.datamodel.ClearInternetCloudIntfList

(

cloudName

)

delete all the intf of the internet cloud ,from v2.1 (2019-03-04)

Parameters

cloudName

(string) internet cloud name not supported after IEv8.02

ClearPhantomInterface()

def netbrain.sysapi.datamodel.ClearPhantomInterface	(		device_name,
			interface_type
	)

delete all the intf of the device

Parameters

device_name	(string) device name
interface_type	(string) interface type

Returns

True or False

ClearPyLastError()

def netbrain.sysapi.datamodel.ClearPyLastError

(

)

CompleteInterfaceName()

def netbrain.sysapi.datamodel.CompleteInterfaceName	(		device_name,
			interface_name
	)

get interface full name

Parameters

device_name	(string) device name
interface_name	(string) interface name

Returns

interface full name

CreateDeviceGroup()

def netbrain.sysapi.datamodel.CreateDeviceGroup	(		device_group_name,
			device_group_type
	)

create device group

Parameters

device_group_name	(string) device group name
device_group_type	(int) device group type - Public = 0, Private = 1

Returns

True or False

DeleteDevices()

def netbrain.sysapi.datamodel.DeleteDevices

(

device_names

)

delete devices

Parameters

device_names

(list) device name

Returns

True or False

DeleteLayoutTagForDevs()

def netbrain.sysapi.datamodel.DeleteLayoutTagForDevs	(		devNames,
			tagNames
	)

Delete LayoutTag For Devices.

Parameters

devNames	device name list
tagNames	tag name list

Returns

True or False

DeleteMacDeviceById()

def netbrain.sysapi.datamodel.DeleteMacDeviceById

(

id

)

delete mac device by id

Parameters

id	(string) id

Returns

True or False

DeleteMacDeviceByMac()

def netbrain.sysapi.datamodel.DeleteMacDeviceByMac

(

mac

)

delete mac device by mac

Parameters

mac

mac

Returns

True or False

DeleteMPLSCloud()

def netbrain.sysapi.datamodel.DeleteMPLSCloud

(

cloudName

)

DeleteOpenTopoInterfaces()

def netbrain.sysapi.datamodel.DeleteOpenTopoInterfaces

(

intfIds

)

Delete documents from OpenTopoInterface Collections.

Parameters

intfIds

interface id list

Returns

True or False

DelMissDevice()

def netbrain.sysapi.datamodel.DelMissDevice

(

name

)

Delete Missdevice in current domain.

Parameters

name(string)

name of missdevice

Returns

None

DisableBenchmarkOneProcess()

def netbrain.sysapi.datamodel.DisableBenchmarkOneProcess	(		sourceId,
			processName
	)

DisableBenchmarkOneProcess.

Parameters

sourceId

string benchmark id

processName

string processName must be one of these:- IPv4 L3 Topology/IPv6 L3 Topology/L2 Topology/L3 VPN Tunnel/Logical Topology/L2 Overlay Topology/ Recalculate Dynamic Device Groups/Recalculate MPLS Virtual Route Tables/ Build Default Device Data View/ Visual Space Templates\Built-in Visual Space Templates\ACI Application/ Visual Space Templates\Built-in Visual Space Templates\ACI Overlay/ Visual Space Templates\Built-in Visual Space Templates\ESXi Host to Network/ Visual Space Templates\Built-in Visual Space Templates\ESXi Physical and Virtual Relationship/ Visual Space Templates\Built-in Visual Space Templates\NSX Relationship of Components Visual Space/ Visual Space Templates\Built-in Visual Space Templates\NSX Transport Zone View Network Visual Space/ Schedule Update Map

Returns

bool True or False

ExcutePrivateTuneDevices()

def netbrain.sysapi.datamodel.ExcutePrivateTuneDevices

(

condition

)

Excute Private Tune Devices.

Parameters

condition

tune parameter

See also

tunesettingutil.ConditionOfTDS

example:

from netbrain.sysapi import tunesettingutil
 from netbrain.sysapi import datamodel

 condition = tunesettingutil.ConditionOfTDS()


 device_names =["Device name"]
 query={"name":{"$in":device_names}}
 dev_ids = datamodel.QueryDeviceIds(query)

 condition.devIds = dev_ids


 datamodel.ExcutePrivateTuneDevices(condition)

 datamodel.GetPrivateTuneDeviceResultByDevIds(dev_ids)

Returns

task id for True ,None for False

ExcutePrivateTuneOneDevice()

def netbrain.sysapi.datamodel.ExcutePrivateTuneOneDevice

(

devId

)

Excute Private Tune one Device.

Parameters

devId

device id

example:

from netbrain.sysapi import tunesettingutil
 from netbrain.sysapi import datamodel
 device_names =["Device Name"]
 query={"name":{"$in":device_names}}
 dev_ids = datamodel.QueryDeviceIds(query)

 if dev_ids[0] :
     datamodel.ExcutePrivateTuneOneDevice(dev_ids[0])
     datamodel.GetPrivateTuneDeviceResultByDevIds([dev_ids[0]])

Returns

task id for True ,None for False

ExcuteSharedTuneDevice()

def netbrain.sysapi.datamodel.ExcuteSharedTuneDevice	(		condition,
			option
	)

Excute Shared Tune Device.

Parameters

condition

tune parameter

See also

tunesettingutil.ConditionOfTDS

Parameters

option

tune option

See also

tunesettingutil.OptionOfTDS

example:

from netbrain.sysapi import tunesettingutil
from netbrain.sysapi import datamodel

condition = tunesettingutil.ConditionOfTDS()
option = tunesettingutil.OptionOfTDS()


device_names =["Device Name"]
query={"name":{"$in":device_names}}
dev_ids = datamodel.QueryDeviceIds(query)

condition.devIds = dev_ids

option.isCheckPing = True
option.isCheckSnmp = True
option.isCheckCliLogin = True
option.isCheckCliEnable = True

datamodel.ExcuteSharedTuneDevice(condition, option)

datamodel.GetTuneDeviceResultByDevIds(dev_ids)

Returns

task id for True ,None for False

ExcuteTuneOneDevice()

def netbrain.sysapi.datamodel.ExcuteTuneOneDevice

(

devId

)

Excute Shared Tune one Device.

Parameters

devId

device id

example:

from netbrain.sysapi import tunesettingutil
 from netbrain.sysapi import datamodel

 device_names =["Device Name"]
 query={"name":{"$in":device_names}}
 dev_ids = datamodel.QueryDeviceIds(query)

 if dev_ids[0] :
     datamodel.ExcuteTuneOneDevice(dev_ids[0])
     datamodel.GetTuneDeviceResultByDevIds([dev_ids[0]])

Returns

task id for True ,None for False

FindVendorByMAC()

def netbrain.sysapi.datamodel.FindVendorByMAC

(

mac

)

find vendor by mac

Parameters

mac	(string) mac

Returns

vendor string

get_unknown_ips()

def netbrain.sysapi.datamodel.get_unknown_ips

(

)

GetAllDeviceLiveCostInBMTask()

def netbrain.sysapi.datamodel.GetAllDeviceLiveCostInBMTask

(

sourceId

)

GetAllDeviceLiveCostInBMTask.

Parameters

sourceId

string benchmark id

Returns

string json string like this:

[
  {
    "_id":"1eb46520-91de-4b6e-bb54-e6a41330b7db",
    "arpTable":"Succeed",
    "bgpNbrTable":"N/A",
    "cdpTable":"Succeed",
    "cliConfig":true,
    "config":"Succeed",
    "dataSourceId":"fc6195db-183b-4658-a960-392307a287f7",
    "deviceId":"6a1f092d-5b9b-49b3-9f17-bc478a0dd6c6",
    "deviceInfo":"Succeed",
    "deviceName":"BJ*POP",
    "hasConfig":true,
    "interfaceInfo":"Succeed",
    "macTable":"Succeed",
    "routeTable":"Succeed",
    "spendSecond":196,
    "stpTable":"N/A"
  }
]

GetAllDuplicateIp()

def netbrain.sysapi.datamodel.GetAllDuplicateIp

(

)

---

Returns

[list] All duplicate ip list,each item is one duplicateIp object,not grouped by ip,retult like follow:

[{
    "description": "",
    "devId": "7848d5c3-e4e3-49f5-9e57-f9bd2fb398d1",
    "devInterfaceId": "57792cce-9417-4dee-bff3-4f22cecc3f1d",
    "deviceName": "",
    "ip": "10.10.2.27/22",
    "ipInterfaceId": "89892760-d838-40f0-98ed-8033610e18ca",
    "ipInterfaceName": "Ethernet0 10.10.2.27/22",
    "isIpConflicted": false,
    "nonDuplicateIP": false,
    "vrf": "",
    "zone": ""
}, {
    "description": "",
    "devId": "016fa17c-cc69-47b7-82c1-35c2ec79b4f2",
    "devInterfaceId": "aee8f1d7-fbbf-42f8-af90-5711275b85d5",
    "deviceName": "",
    "ip": "10.10.2.27/22",
    "ipInterfaceId": "4bbd7682-6146-4770-bcb5-f061ae6b4feb",
    "ipInterfaceName": "Ethernet0 10.10.2.27/22",
    "isIpConflicted": false,
    "nonDuplicateIP": false,
    "vrf": "",
    "zone": ""
}]

GetAllPhantomInterfaceTypes()

def netbrain.sysapi.datamodel.GetAllPhantomInterfaceTypes

(

)

get all phantom interface types

Returns

interface types

Return values

["ipIntfs",ip6Intfs,greVpnIntfs,"ipsecVpnIntfs"]

GetAllSitePath()

def netbrain.sysapi.datamodel.GetAllSitePath

(

)

Get all site paths.

siteCategory

:
siteCategory:
  RootSite = 0,
  ContainerSite = 1,
  LeafSite = 2,
  UnassignedSite = 3,
  ExcludedDeviceSite = 4,

Returns

all site paths site path sample: site_info = { "sitePath": "My Network\CHBS\WSJ-210-U2-14", "siteName": "WSJ-210-U2-14", "siteCategory": 2 }

GetBenchmarkAPIServerIDList()

def netbrain.sysapi.datamodel.GetBenchmarkAPIServerIDList

(

sourceId

)

Get SDN Api Server id of Benchmark task.

Parameters

sourceId

(string) benchmark id

Returns

(list) sdn api server ids.

ApiServerIds=datamodel.GetBenchmarkAPIServerIDList("24b26155-f306-77e6-a3ec-cda30f05b28b")
pluginfw.AddLog("ApiServerIds %s" % ApiServerIds)

=> ApiServerIds ['844ce8f3-f610-4fe3-926b-cad4527f939c']

GetBenchmarkExcludeDeviceGroup()

def netbrain.sysapi.datamodel.GetBenchmarkExcludeDeviceGroup

(

sourceId

)

GetBenchmarkExcludeDeviceGroup.

Parameters

sourceId

string benchmark id

Returns

string json string like this: [ "#ISIS test", "#OSPF 10" ]

GetBenchmarkIdByName()

def netbrain.sysapi.datamodel.GetBenchmarkIdByName

(

sourceName

)

GetBenchmarkIdByName.

Parameters

sourceName

string benchmark name

Returns

string benchmark id

GetBenchmarkTargetDevices()

def netbrain.sysapi.datamodel.GetBenchmarkTargetDevices

(

sourceId

)

Get Benchmark target devices.

Parameters

sourceId

(string) benchmark id

Returns

(list) device name list like: [ "Device1", "Device2" ]

GetCurrentDomainInfo()

def netbrain.sysapi.datamodel.GetCurrentDomainInfo

(

)

get domain info

Returns

domain info (dict) {domainDbName:string, domainId:string, tenantDbName:string,tenantId:string}

{
    'domainDbName': 'L2Topology',
    'domainId': '41b1067e-80f4-49ac-838a-266d9cf81651',
    'tenantDbName': 'Topology',
    'tenantId': '1cfb3437-f948-c751-75e7-8a3f063b7a92'
}

GetCurrentMapId()

def netbrain.sysapi.datamodel.GetCurrentMapId

(

)

get current map id

Note

only support qapp and path discovery

Returns

current map id

GetCurrentMapPageId()

def netbrain.sysapi.datamodel.GetCurrentMapPageId

(

)

get current map page id

Note

only support qapp and path discovery

Returns

current map page id

GetCurrentRunbookID()

def netbrain.sysapi.datamodel.GetCurrentRunbookID

(

)

get current runbook id

Note

only support runbook run qapp.

Returns

current runbook id

GetDataViewTemplete()

def netbrain.sysapi.datamodel.GetDataViewTemplete

(

dvt_path

)

get dvt by path

Parameters

dvt_path

dvt path

Returns

dvt content

GetDeviceIdsFromDeviceGroup()

def netbrain.sysapi.datamodel.GetDeviceIdsFromDeviceGroup	(		device_group_name,
			type = -1
	)

get device ids from device group

Parameters

device_group_name	(string) device group name
type	(int) device group type(default -1)

Returns

device id list

Return values

["device

id1", "device id2", ...]

GetDeviceIdsFromSite()

def netbrain.sysapi.datamodel.GetDeviceIdsFromSite	(		site_path,
			include_child = False
	)

get device ids from site

Parameters

site_path	(string) site full path
include_child	(bool) include child - default : False

Returns

device id list

Return values

["device

id1", "device id2", ...]

GetDeviceInterfaceId()

def netbrain.sysapi.datamodel.GetDeviceInterfaceId	(		device,
			phantom_interface_name,
			phantom_interface_type,
			get_new = False
	)

Get interface id by device name, interface name, interface type.

Parameters

device	(string) device name
phantom_interface_name	(string) phantom_interface_name
phantom_interface_type	(string) interface type "intfs" "ipIntfs" "ip6Intfs" "greVpnIntfs" "ipsecVpnIntfs"
get_new	(bool) Whether to use new data(When the interface data is modified in your script, it needs to be set to true in order to obtain the updated data)

Returns

interface id

GetDeviceMACInfo()

def netbrain.sysapi.datamodel.GetDeviceMACInfo

(

filter_list

)

get mac info

Parameters

filter_list

(dic) - {"device1":["mac1", "mac2", ...], "device2":[], ....}

Returns

mac info list

Return values

[["host

name", "port name", "vlan name", "address"], [...], ...]

GetDeviceNameFromIp()

def netbrain.sysapi.datamodel.GetDeviceNameFromIp

(

strIp

)

Get device name by IP(interface ips.ip)

Attention

The ip may be used for multi interface, but only return one

Parameters

strIp

interface ip

Returns

device name

GetDeviceObject()

def netbrain.sysapi.datamodel.GetDeviceObject

(

device

)

Get device object by device name.

Parameters

device

device name

Returns

device object

example

:
   device_name = "cisco route"
   device_obj = GetDeviceObject(device_name)
   device_obj["descr"] = "cisco route"
   SetDeviceObject(device_name, device_obj)

GetDeviceObjectById()

def netbrain.sysapi.datamodel.GetDeviceObjectById

(

devId

)

Get device object by device id.

Parameters

devId

device identify

Returns

device object

example

:
   devId = "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
   device_obj = GetDeviceObjectById(devId)
   device_obj["descr"] = "cisco route"
   SetDeviceObject(device_obj["name"], device_obj)

GetDeviceProperty()

def netbrain.sysapi.datamodel.GetDeviceProperty	(		property_name,
			device_name
	)

Get device property.

Parameters

property_name	(string) property name
device_name	(string) device name

Returns

property value.
This func will return None, if dict or list is empty.

GetDeviceSetting()

def netbrain.sysapi.datamodel.GetDeviceSetting

(

device

)

Get device setting.

Parameters

device

name (string)

Returns

device setting (dict)

Return values

example

{ 'ApplianceId': 'fs36', 'CliSetting': { 'AccessMethod': 1, 'LoginScript': { 'UseLoginScript': False }, 'SSHKeyId': '', 'SSHPort': 22, 'TelnetPort': 23, 'TelnetProxyId': '', 'TelnetProxyIdForSmartCLI': '' }, 'CpuExpression': '', 'DependOn': None, 'DriverId': 'b2d313fe-43e6-4d5f-9189-b3af6b71a83a', 'Extension': None, 'ExternalServers': None, 'HostName': 'xxxx', 'LiveHostName': 'xxxx', 'LiveStatus': 1, 'Locked': False, 'ManageIp': 'xx.xx.xx.xx', 'ManageIpInt': 2887256578, 'MemoryExpression': '', 'Mode': 0, 'SNMPSetting': { 'snmpPort': 161, 'snmpVersion': 2, 'v3': { 'authMode': 0, 'authPro': 0, 'contextName': '', 'encryptPro': 0 } }, 'SubType': 2, 'Version': 420, }

GetDeviceSiteFullPath()

def netbrain.sysapi.datamodel.GetDeviceSiteFullPath

(

device

)

get device site full path

Parameters

device

(string) device name

Returns

site full path (string)

GetDeviceSiteName()

def netbrain.sysapi.datamodel.GetDeviceSiteName

(

device

)

get device site name

Parameters

device

(string) device name

Returns

site name (string)

GetDevicesLearnedSpecifiedMac()

def netbrain.sysapi.datamodel.GetDevicesLearnedSpecifiedMac

(

mac

)

Get Devices which had Learned Specified Mac.

Note

from V10.02

Parameters

mac	(string) intergface mac address, like 0050.5685.2A9E

Returns

devId and devName list which devices had Learned Specified Mac

[
  {
      'devId': '7b68a652-5e68-4b06-adac-fd42e7575db0',
      'devName': 'sw-4500-15.254'
  },
  {
      'devId': '99f418e7-f634-4535-a877-3a5f7a7ed5a1',
      'devName': 'sw3560-123'
  }
]

GetDevIdsByNames()

def netbrain.sysapi.datamodel.GetDevIdsByNames

(

devNames

)

query device id list by device name

Parameters

query

condition

Returns

device id list

GetDiscoverInput()

def netbrain.sysapi.datamodel.GetDiscoverInput	(		datasourceId,
			isTaskId = None
	)

GetDiscoverInput.

Parameters

datasourceId	string benchmarkdefineID or devicedatasourceID
isTaskId	bool default False, if datasourceId is benchmarkdefineID, the isTaskId must be seted False,otherwise the isTaskId must be seted True

Returns

string json string like this

{
  "accessOrder":4,
  "cliForceTimeout":600,
  "discoverInfo":{"comefrom":"","comefromMask":"","depth":0,"desc":"","ifname":"","ipSrc":0,"orignalProxy":"","proxy":"","subnetList":[]},
  "discoverOption":2,
  "domainName":"",
  "domainOption":1,
  "fromScan":false,
  "hostips":["172.24.31.195"],
  "isAllDevices":false,
  "jumpboxOnly":false,
  "limitRunTimeMinutes":0,
  "maxDepth":0,
  "pingTimeout":2,
  "pingTryTimes":2,
  "pollingOrder":3,
  "scanMaskLength":24,
  "skipPing":false,
  "snmpIfPingFailed":true,
  "snmpOnly":false,
  "telnetIfPingFailed":false,
  "updateDeviceSetting":true,
  "useAllNap":true
}

GetDonotScan()

def netbrain.sysapi.datamodel.GetDonotScan

(

)

GetDonotScan.

Returns

string donotscan json string like { "_id" : "ad77c9a6-a1a0-4593-b356", "subnets" : [], "subTypes" : [2001] }

GetDriverIdBySysOID()

def netbrain.sysapi.datamodel.GetDriverIdBySysOID

(

sysObjectID

)

GetDriverIdByVendorModel()

def netbrain.sysapi.datamodel.GetDriverIdByVendorModel	(		vendor,
			model
	)

get driver id from vendor model

Parameters

vendor	name of vendor, e.g. "Cisco"
model	name of model, e.g. "TelePresence MCU MSE 8510"

GetHostnameChangeList()

def netbrain.sysapi.datamodel.GetHostnameChangeList

(

jobId

)

get host name change list

Parameters

jobId

Returns

[{HostNameChangeInfo}, {HostNameChangeInfo}, ...]

See also

:UpsertHostnameChangeList

:KeepLastChangeDevice

result example:

[
   {
       "_id": "123456", // sn
       "createTime": "datetime.datetime(2020, 01, 01, 11, 3, 46, 201000)",
       "devices": [
           {
               "_id": "517d0f33-8c1d-4646-bbc5-c2a5f2e849a5_1",
               "fDiscoveryTime": "datetime.datetime(2020, 01, 01, 9, 55, 57)",
               "lDiscoveryTime": "datetime.datetime(2020, 01, 01, 9, 55, 57)",
               "mgmtIP": "1.2.3.4",
               "name": "device1"
           },
           {
               "_id": "517d0f33-8c1d-4646-bbc5-c2a5f2e849a5",
               "fDiscoveryTime": "datetime.datetime(2020, 01, 01, 9, 55, 57)",
               "lDiscoveryTime": "datetime.datetime(2020, 01, 01, 9, 55, 57)",
               "mgmtIP": "1.2.3.4",
               "name": "device2"
           }
       ],
       "jobId": "abdf6ce9-8089-401a-a62d-1d9f2d2161c4"
   }
]

GetInterfaceIdsByDeviceName()

def netbrain.sysapi.datamodel.GetInterfaceIdsByDeviceName	(		device,
			intf_type
	)

Get interface id list by device name.

Parameters

device	(string) device name
intf_type	(string) interface type "" "intfs" "ipIntfs" "ip6Intfs" "greVpnIntfs" "ipsecVpnIntfs"

Note

If intf_type is "", the func will return interface id of all interface type

Returns

interface id list

Return values

[{"interface

id":"111", "interface type":""}, {XXX}, {XXX} ]

GetInterfaceIdsByType()

def netbrain.sysapi.datamodel.GetInterfaceIdsByType

(

intf_type

)

Get interface id list by interface type.

Parameters

intf_type

(string) interface type "intfs" "ipIntfs" "ip6Intfs" "greVpnIntfs" "ipsecVpnIntfs"

Returns

interface id list

Return values

[{"interface

id":"111", "interface type":""}, {XXX}, {XXX} ]

GetInterfaceObject()

def netbrain.sysapi.datamodel.GetInterfaceObject	(		device,
			intf_name,
			intf_type,
			get_new = False
	)

Get interface object by device name, interface name.

Parameters

device	(string) device name
intf_name	(string) interface name
intf_type	(string) interface type "intfs" "ipIntfs" "ip6Intfs" "greVpnIntfs" "ipsecVpnIntfs"
get_new	(bool) Whether to use new data(When the interface data is modified in your script, it needs to be set to true in order to obtain the updated data)

Returns

interface object dic

GetInterfaceObjectById()

def netbrain.sysapi.datamodel.GetInterfaceObjectById	(		intf_id,
			intf_type,
			get_new = False
	)

Get interface object by interface id.

Parameters

intf_id	(string) interface id
intf_type	(string) interface type "intfs" "ipIntfs" "ip6Intfs" "greVpnIntfs" "ipsecVpnIntfs"
get_new	(bool) Whether to use new data(When the interface data is modified in your script, it needs to be set to true in order to obtain the updated data)

Returns

interface object dic

GetInterfaceProperty()

def netbrain.sysapi.datamodel.GetInterfaceProperty	(		property_name,
			device,
			intf_name,
			intf_type
	)

Get interface attribute.

Parameters

property_name	(string) property name
intf_type	(string) interface type
device	(string) device name
intf_name	(string) interface name

Returns

property value.
This func will return None, if dict or list is empty.

GetInterfaceShortName()

def netbrain.sysapi.datamodel.GetInterfaceShortName	(		device_name,
			interface_name
	)

get interface short name

Parameters

device_name	(string) device name
interface_name	(string) interface name

Returns

interface short name

GetInternetCloud()

def netbrain.sysapi.datamodel.GetInternetCloud

(

cloud_name

)

get internet cloud.

from v2.0 (2019-02-14)

Parameters

cloud_name

(string) internet cloud name

Returns

(object) internet cloud json formatted object.

See also

GetDeviceObject

GetInternetCloudIntfList()

def netbrain.sysapi.datamodel.GetInternetCloudIntfList

(

cloudName

)

get internet cloud interface list.

from v2.0 (2019-02-14)

Parameters

cloudName

(string) internet cloud name

Returns

all interfaces of internet cloud

See also

QueryInterfaceObjects

GetInternetCloudProperty()

def netbrain.sysapi.datamodel.GetInternetCloudProperty	(		property_name,
			cloud_name
	)

get internet cloud property.

from v2.0 (2019-02-14)

Parameters

property_name	(string) property name
cloud_name	(string) internet cloud name

Returns

property value.
This func will return None, if dict or list is empty.

See also

GetDeviceProperty

GetMacDevicesByMac()

def netbrain.sysapi.datamodel.GetMacDevicesByMac

(

mac

)

get mac device by mac

Parameters

mac

mac

Returns

mac device list

GetMemberInterfaceIdsBelong2Channel()

def netbrain.sysapi.datamodel.GetMemberInterfaceIdsBelong2Channel	(		device,
			intf
	)

get member interface ids Belong2Channel

Parameters

device	(string) device name
intf	(string) interface name

Returns

interface id list

Return values

[id1,id2,...]

GetMissDevice()

def netbrain.sysapi.datamodel.GetMissDevice	(		rtnFileds = None,
			device_name_list = None
	)

GetMissDevice.

Parameters

rtnFileds	dict like this: { "devType":1, "devTypeName":1, "ctime":1, "model":1, "mgmtIP":1, "name":1, "oid":1, "vendor":1 }
device_name_list	device name list

Returns

string josn string like this:

[
  {
    "_id":"0cf8ccf3-33a3-44fe-aa26-82e659f3b835",
    "ctime":{"$date":1547799789000},
    "devType":1004,
    "devTypeName":"End System",
    "mgmtIP":"172.25.6.3",
    "model":"ciscoGatewayServer",
    "name":"Emu_MV_GW",
    "oid":"1.3.6.1.4.1.9.1.1",
    "vendor":"Cisco"
  }
]

GetModuleObject()

def netbrain.sysapi.datamodel.GetModuleObject	(		device_name,
			module_name
	)

get device's module object by module name.

Parameters

device_name	(string) device name
module_name	(string) module name

Returns

object (dic) module object

GetModuleProperty()

def netbrain.sysapi.datamodel.GetModuleProperty	(		property_name,
			device_name,
			module_name
	)

Get module attribute.

Parameters

property_name	(string) property name
device_name	(string) device name
module_name	(string) module name

Returns

property value.
This func will return None, if dict or list is empty.

GetMPLSCloud()

def netbrain.sysapi.datamodel.GetMPLSCloud

(

cloudName

)

get the MPLS cloud define.

from v2.0 (2019-02-14)

Parameters

cloudName

(string) mpls cloud name

Returns

(object) MPLS Object

GetMPLSCloudDynamicCEList()

def netbrain.sysapi.datamodel.GetMPLSCloudDynamicCEList	(		cloudName,
			ceName = None,
			ceIntfName = None
	)

get the dynamic CE list of MPLS cloud.

from v2.0 (2019-02-14)

Parameters

cloudName	(string) mpls cloud name
ceName	(string) ce device name,default is None,get all the dynamic CE from MPLS Cloud
ceIntfName	(string) ce interface name,default is None,get all the dynamic CE interface from MPLS Cloud

Returns

(list of object) all the CE list. ex.

ceNbrs=datamodel.GetMPLSCloudStaticCE("Mpls2",'d367d36d-852d-4d6c-8455-a1ece3a5c6a8')
return example:
[{
    'asNum': 65535,
    'ceIfVpn': '',
    'ceIntfIP': '172.24.14.4/24',
    'ceIntfName': 'FastEthernet0/1',
    'ceName': 'BJ-R3',
    'ceVpn': '55',
    'descr': 'Static',
    'devId': '5ab3aa49-69bd-438e-be58-ca8bb467d944',
    'flag': 1,
    'groupType': 'Dynamic',
    'ifname': 'd367d36d-852d-4d6c-8455-a1ece3a5c6a8',
    'ip': '172.24.14.6/24',
    'mplsId': '4b8aa1e9-1ad1-7ba5-7692-89484eef26c0',
    'peIp': '172.24.14.6/24',
    'routingProtocol': ''
}]

GetMPLSCloudExcludeCEList()

def netbrain.sysapi.datamodel.GetMPLSCloudExcludeCEList	(		cloudName,
			ceName = None,
			ceIntfName = None
	)

GetMPLSCloudProperty()

def netbrain.sysapi.datamodel.GetMPLSCloudProperty	(		propertyName,
			cloudName
	)

get mpls cloud property.

from v2.0 (2019-02-14)

Parameters

propertyName	(string) property name
cloudName	(string) internet cloud name

Returns

property value.
This func will return None, if dict or list is empty.

See also

GetDeviceProperty

GetMPLSCloudStaticCEList()

def netbrain.sysapi.datamodel.GetMPLSCloudStaticCEList	(		cloudName,
			ceName = None,
			ceIntfName = None
	)

get the static CE list of MPLS cloud.

from v2.0 (2019-02-14)

Parameters

cloudName	(string) mpls cloud name
ceName	(string) ce device name,default is None,get all the static CE from MPLS Cloud
ceIntfName	(string) ce interface name,default is None,get all the static CE interface from MPLS Cloud

Returns

(list of object) all the CE list. ex.

ceNbrs=datamodel.GetMPLSCloudStaticCE("Mpls2",'d367d36d-852d-4d6c-8455-a1ece3a5c6a8')
return example:
[{
    'asNum': 65535,
    'ceIfVpn': '',
    'ceIntfIP': '172.24.14.4/24',
    'ceIntfName': 'FastEthernet0/1',
    'ceName': 'BJ-R3',
    'ceVpn': '55',
    'descr': 'Static',
    'devId': '5ab3aa49-69bd-438e-be58-ca8bb467d944',
    'flag': 0,
    'groupType': 'Static',
    'ifname': 'd367d36d-852d-4d6c-8455-a1ece3a5c6a8',
    'ip': '172.24.14.6/24',
    'mplsId': '4b8aa1e9-1ad1-7ba5-7692-89484eef26c0',
    'peIp': '172.24.14.6/24',
    'routingProtocol': ''
}]

GetNDTItems()

def netbrain.sysapi.datamodel.GetNDTItems

(

)

return all NDT Items

Returns

all NDT Item

Return values

[{item1},{item2}...]

GetNewDevice()

def netbrain.sysapi.datamodel.GetNewDevice

(

rtnFileds = None

)

GetNewDevice.

Parameters

rtnFileds

dict like this: { "devType":1, "devTypeName":1, "ctime":1, "model":1, "mgmtIP":1, "name":1, "oid":1, "vendor":1 }

Returns

josn string like this:

[
  {
    "_id":"a19eca8b-01b8-444a-8c3f-dc9e600a5c58",
    "ctime":{"$date":1547799744000},
    "devType":1004,
    "devTypeName":"End System",
    "mgmtIP":"10.10.32.170",
    "model":"ciscoGatewayServer",
    "name":"FanWei_Lab_Gateway",
    "oid":"1.3.6.1.4.1.9.1.1",
    "vendor":"Cisco"
  }
}

GetPhantomInterfaceIds()

def netbrain.sysapi.datamodel.GetPhantomInterfaceIds	(		device,
			device_interface_name,
			phantom_interface_type
	)

Get phantom interface id by device name, interface name, interface type.

Parameters

device	(string) device name
device_interface_name	(string) device_interface_name
phantom_interface_type	(string) interface type "intfs" "ipIntfs" "ip6Intfs" "greVpnIntfs" "ipsecVpnIntfs"

Returns

interface id list

Return values

[{"interface

id":"111", "interface type":""}, {XXX}, {XXX} ]

GetPrivateTuneDeviceResultByDevIds()

def netbrain.sysapi.datamodel.GetPrivateTuneDeviceResultByDevIds

(

devIds

)

Get Pravite Tune Device Reuslt by device ids.

Parameters

devIds

device id list

Returns

tune reuslt [{result1}, {result2}, ...]

GetProfileClass()

def netbrain.sysapi.datamodel.GetProfileClass

(

device

)

GetProxyServerStatus()

def netbrain.sysapi.datamodel.GetProxyServerStatus

(

fsId

)

Network settings APIs - GetProxyServerStatus.

Parameters

fsId

fsId

Returns

True or False If return False, may be:
1.Can not find Front Server by fsId.
2.Failed to connect Front Server Controller.

GetPyLastError()

def netbrain.sysapi.datamodel.GetPyLastError

(

)

GetPyLastErrorCode()

def netbrain.sysapi.datamodel.GetPyLastErrorCode

(

)

GetQappInfo()

def netbrain.sysapi.datamodel.GetQappInfo

(

qapp_path

)

get qapp content by path

Parameters

qapp_path

qapp path

Returns

qapp content

GetRunbookTemplete()

def netbrain.sysapi.datamodel.GetRunbookTemplete

(

runbook_templete_path

)

get runbook templete by path

Parameters

runbook_templete_path

runbook templete path

Returns

runbook templete content

GetSchemaType()

def netbrain.sysapi.datamodel.GetSchemaType

(

schema_name

)

get schema type by schema name

Parameters

schema_name

(string) schema name

Returns

schema type - may be
"int",
"int64",
"double",
"bool",
"string",
"list",
"object",
"time",
"ipv4",
"ipv6",
"mac",
"url",
"file"

GetSDNNodesByServerID()

def netbrain.sysapi.datamodel.GetSDNNodesByServerID

(

serverId

)

Get Benchmark SDN scope ranges.

Parameters

serverId

(string) api server id,you can got it by call GetBenchmarkAPIServerIDList

Returns

(list) sdn node ids.

ex.
 ApiServerIds=datamodel.GetBenchmarkAPIServerIDList("24b26155-f306-77e6-a3ec-cda30f05b28b")

 for serverId in ApiServerIds:
     devIds = datamodel.GetSDNNodesByServerID(serverId)
     pluginfw.AddLog("dev ids %s" % devIds)

  => dev ids ['c9cc4f71-47cf-be20-059c-a37a1b3d8565',......]

GetSiteProperty()

def netbrain.sysapi.datamodel.GetSiteProperty	(		property_name,
			site_path
	)

get site property

Parameters

site_path	(string) site path
property_name	(string) property name

Returns

property value (string)

GetSNMPDevices()

def netbrain.sysapi.datamodel.GetSNMPDevices	(		rtnFileds = None,
			device_name_list = None
	)

GetSNMPDevices.

Parameters

rtnFileds	dict like this: { "devType":1, "devTypeName":1, "ctime":1, "model":1, "mgmtIP":1, "name":1, "oid":1, "vendor":1 }
device_name_list	name list

Returns

string josn string like this:

[
  {
    "_id":"8d073b95-1799-4ddc-b7ce-b971905407d5",
    "ctime":{"$date":1547799756000},
    "devType":2001,
    "devTypeName":"Cisco IOS Switch",
    "mgmtIP":"172.25.5.1",
    "model":"catalyst356048TS",
    "name":"BJ_L2_Core_5",
    "oid":"1.3.6.1.4.1.9.1.634",
    "vendor":"Cisco"
  }
]

GetTuneDeviceResultByDevId()

def netbrain.sysapi.datamodel.GetTuneDeviceResultByDevId

(

devId

)

Get Shared Tune Device Reuslt by device id.

Parameters

devId

device id

Returns

tune reuslt

GetTuneDeviceResultByDevIds()

def netbrain.sysapi.datamodel.GetTuneDeviceResultByDevIds

(

devIds

)

Get Shared Tune Device Reuslt by device ids.

Parameters

devIds

device id list

Returns

tune reuslt [{result1}, {result2}, ...]

GetUnclassifiedNetworkDevice()

def netbrain.sysapi.datamodel.GetUnclassifiedNetworkDevice

(

rtnFileds = None

)

GetUnclassifiedNetworkDevice.

Parameters

rtnFileds

dict like this: { "subType":1, "subTypeName":1, "lDiscoveryTime":1, "model":1, "location":1, "mgmtIP":1, "name":1, "oid":1, "vendor":1 }

Returns

string josn string like this:

[
  {
    "_id":"9e08c712-e29c-4bea-b642-1b454e7fad3e",
    "lDiscoveryTime":{"$date":1547799697000},
    "mgmtIP":"172.27.0.77",
    "model":"",
    "name":"qapp-aruba-iap",
    "oid":"1.3.6.1.4.1.14823.1.2.71",
    "subType":1021,
    "subTypeName":"Unclassified Device",
    "vendor":""
  }
]

GetUnknowSNMPSysObjectId()

def netbrain.sysapi.datamodel.GetUnknowSNMPSysObjectId

(

rtnFileds = None

)

GetUnknowSNMPSysObjectId.

Parameters

rtnFileds

dict like this: { "devType":1, "devTypeName":1, "contact":1, "ftime":1, "ipfrom":1, "location":1, "mgmtIP":1, "name":1, "oid":1 }

Returns

string josn string like this:

[
  {
    "_id":"62331697-f413-48ca-9bb2-707aa131c5e5",
    "contact":"",
    "devType":1021,
    "devTypeName":"Unclassified Device",
    "ftime":{"$date":1544679511000},
    "ipfrom":"10.10.19.252",
    "location":"",
    "mgmtIP":"172.27.0.77",
    "name":"qapp-aruba-iap",
    "oid":"1.3.6.1.4.1.14823.1.2.71"
  }
]

GetVendorModel()

def netbrain.sysapi.datamodel.GetVendorModel

(

sysoid

)

get vendor model

Parameters

sysoid

(string) oid

Returns

[vendorName(string), modelName(string), deviceType(int)]

KeepLastChangeDevice()

def netbrain.sysapi.datamodel.KeepLastChangeDevice

(

snInfoList

)

keep last change device

Parameters

snInfoList

(dic)host name change list

snInfoList format:

[
     {
        "sn": "67108914",
        "deviceIds": [
            "517d0f33-8c1d-4646-bbc5-c2a5f2e849a5_1",
            "517d0f33-8c1d-4646-bbc5-c2a5f2e849a5"
         ]
     }
]

See also

:GetHostnameChangeList

:UpsertHostnameChangeList

Returns

True or False

QueryDataFromDB()

def netbrain.sysapi.datamodel.QueryDataFromDB	(		db,
			collection,
			json_value
	)

QueryDeviceIds()

def netbrain.sysapi.datamodel.QueryDeviceIds

(

query

)

query device id list by query

Warning

The func will return all device id when query is empty.

Parameters

query

condition

Returns

device id list

QueryDeviceObjects()

def netbrain.sysapi.datamodel.QueryDeviceObjects

(

query

)

query device object

Warning

The func will return all object when query is empty.

Parameters

query

query condition

Returns

query result

QueryInterfaceIds()

def netbrain.sysapi.datamodel.QueryInterfaceIds	(		query,
			intf_type
	)

Get interface id list by intf type.

Warning

The func will return all interface id when query is empty.

Parameters

query	(dic) query condition
intf_type	(string) interface type "intfs" "ipIntfs" "ip6Intfs" "greVpnIntfs" "ipsecVpnIntfs"

Returns

interface id list

Return values

[{"interface

id":"111", "interface type":""}, {XXX}, {XXX} ]

QueryInterfaceObjects()

def netbrain.sysapi.datamodel.QueryInterfaceObjects	(		query,
			intf_type
	)

Get interface id list by intf type.

Warning

The func will return all interface object when query is empty.

Parameters

query	(dic) query condition
intf_type	(string) interface type "intfs" "ipIntfs" "ip6Intfs" "greVpnIntfs" "ipsecVpnIntfs"

Returns

interface object list

Return values

[{Intf

object 1},{Intf object 2}, .....]

QueryNodeObjects()

def netbrain.sysapi.datamodel.QueryNodeObjects	(		nbpath_schema,
			query
	)

RecreateDeviceOpenTopoDETable()

def netbrain.sysapi.datamodel.RecreateDeviceOpenTopoDETable

(

devId

)

Rebuild OpenTopoArpTable, OpenTopoMacTable, OpenTopoNdpTable and OpenTopoL3NeighborTable by DataEngine data.

Parameters

devId

device id

Returns

True or False

RemoveCloudStaticProperty()

def netbrain.sysapi.datamodel.RemoveCloudStaticProperty	(		cloud_name,
			cloud_interface
	)

RemoveDeviceFromDeviceGroup()

def netbrain.sysapi.datamodel.RemoveDeviceFromDeviceGroup	(		device,
			device_group_name,
			deviceGroupType = 0
	)

remove device from device group

Note

If device group is private, this func need opUserID (only support qapp, path, sdn, plugin)

Parameters

device	(string) device name
device_group_name	(string) device group name
deviceGroupType	(int) device group type (default 0)- Public = 0, Private = 1

Returns

True or False

RemoveDevicersFromSite()

def netbrain.sysapi.datamodel.RemoveDevicersFromSite	(		siteh_path,
			device_ids
	)

RemoveInternetCloudInterface()

def netbrain.sysapi.datamodel.RemoveInternetCloudInterface	(		cloudName,
			interfaceName
	)

RemovePhantomInterface()

def netbrain.sysapi.datamodel.RemovePhantomInterface	(		device_name,
			interface_name,
			interface_type
	)

Remove phantom interface.

Parameters

device_name	(string) device name
interface_name	(string) interface name
interface_type	(string) interface type

Returns

True or False

SaveDataToDB()

def netbrain.sysapi.datamodel.SaveDataToDB	(		db,
			collection,
			value
	)

SendEmail()

def netbrain.sysapi.datamodel.SendEmail

(

emailInfo

)

Plugin prepare information for email

---

Parameters

emailInfo

dict dict like this: { "subject":"Where to go", "body":"<html><head>suggest</head><body>Hi all, Let's go to the beach.</body>", "recipients":["[email protected]", "[email protected]"], "Ccs":["[email protected]", "[email protected]"], "attachments":[{"content":"\"place\",\"location\"\n\"dalian_beach\", \"dalian\"\n\"qingdao_beach\",\"qingdao\"", "contenttype":"text/csv", "filename":"place.csv"}, {"content":"test", "contenttype":"text/plain; charset=us-ascii","filename":"test.txt"}] }

Returns

bool True or False, if emailInfo json format is wrong, the function will raise exception

SetBenchmarkExcludeDeviceGroup()

def netbrain.sysapi.datamodel.SetBenchmarkExcludeDeviceGroup	(		sourceId,
			devicegroups
	)

SetBenchmarkExcludeDeviceGroup.

Parameters

sourceId	string benchmark id
devicegroups	list group name list like ["#ISIS test","#OSPF 10"]

Returns

bool True or False

SetCloudStaticProperty()

def netbrain.sysapi.datamodel.SetCloudStaticProperty	(		cloud_name,
			prop
	)

SetDeviceCredential()

def netbrain.sysapi.datamodel.SetDeviceCredential	(		device_name,
			username,
			password,
			privilege_username,
			privilege_password,
			access_mode = 0,
			port = 0
	)

Network settings APIs - SetDeviceCredential.

Parameters

device_name	deivce name
username	user name
password	password
privilege_username	privilege_username
privilege_password	privilege_password
access_mode	access mode - 0, – telnet 1, – SSH 2, – SSHv2
port	port port if 0 not change If not find deivce setting by device name, will return False.

SetDeviceObject()

def netbrain.sysapi.datamodel.SetDeviceObject	(		device,
			deviceObj
	)

set device object

Warning

The func will update the whole device object.

Parameters

device
deviceObj	Full device object

example

:
   device_name = "cisco route"
   device_obj = GetDeviceObject(device_name)
   device_obj["descr"] = "cisco route"
   SetDeviceObject(device_name, device_obj)

SetDeviceProperty()

def netbrain.sysapi.datamodel.SetDeviceProperty	(		property_name,
			device_name,
			value
	)

Set device property.

Parameters

property_name	(string) property name
device_name	(string) device name
value

Returns

true or false

SetDeviceSetting()

def netbrain.sysapi.datamodel.SetDeviceSetting

(

device_setting_object

)

Set device setting.

Parameters

device_setting_object

device setting object

Returns

True or False

SetInterfaceObject()

def netbrain.sysapi.datamodel.SetInterfaceObject	(		device,
			intf_name,
			intf_type,
			intf_object,
			get_new = False
	)

Set interface object.

Warning

The func will update the whole interface object.

Parameters

device	(string) device name
intf_name	(string) interface name
intf_type	(string) interface type "intfs" "ipIntfs" "ip6Intfs" "greVpnIntfs" "ipsecVpnIntfs"
intf_object	(dic) interface object
get_new	(bool) Whether to use new data(When the interface data is modified in your script, it needs to be set to true in order to obtain the updated data)

Returns

true or false

SetInterfaceProperty()

def netbrain.sysapi.datamodel.SetInterfaceProperty	(		property_name,
			device,
			intf_name,
			intf_type,
			value,
			get_new = False
	)

Set interface attribute.

Parameters

property_name	(string) property name
intf_type	(string) interface type
device	(string) device name
intf_name	(string) interface name
value
get_new	(bool) Whether to use new data(When the interface data is modified in your script, it needs to be set to true in order to obtain the updated data)

Returns

true or false

SetInterfacePropertyById()

def netbrain.sysapi.datamodel.SetInterfacePropertyById	(		property_name,
			intf_id,
			intf_type,
			value,
			get_new = False
	)

Set interface attribute by Id.

Parameters

property_name	(string) property name
intf_type	(string) interface type
intf_id	(string) interface id
value
get_new	(bool) Whether to use new data(When the interface data is modified in your script, it needs to be set to true in order to obtain the updated data)

Returns

true or false

SetInternetCloud()

def netbrain.sysapi.datamodel.SetInternetCloud	(		cloud_name,
			value
	)

set internet cloud object.

from v2.0 (2019-02-14)

Parameters

cloud_name	(string) internet cloud name
value	internet cloud object,ex.

Returns

true or false

See also

SetDeviceObject

SetInternetCloudIntfList()

def netbrain.sysapi.datamodel.SetInternetCloudIntfList	(		cloudName,
			boudaryInterfaceList
	)

set internet cloud interface list.

from v2.0 (2019-02-14) if the interface name exsist,update the interface,else add new interface. not supported after IEv8.02

Parameters

cloudName	(string) internet cloud name
boudaryInterfaceList	(list of object) cloud boudary interfaces.

example

:
intfs=[{
  "belongToTopoType" : ["L3_Topo_Type"],
  "name" : "Boundary1",
  "remoteIntfs" : [{
      "_id" : "9479aa3c-0648-47d0-ba6e-7e5bb30426b9",
      "devId" : "5ab3aa49-69bd-438e-be58-ca8bb467d944",
      "ip" : "172.24.253.12/32",
      "name" : "Loopback1 172.24.253.12/32",
      "physicalIntfId" : "5b1c4268-dc9a-4397-ab2b-33933b1a5ba5",
      "type" : "ipIntfs"
    }],
  "shortName" : "Boundary1"
},
{
  "belongToTopoType" : ["L3_Topo_Type"],
  "name" : "Boundary2",
  "remoteIntfs" : [{
      "_id" : "05824a4c-8496-484f-901c-b07ba2528e43",
      "devId" : "ebcfe2cb-0b7a-4f9a-8c79-dca3a0ce18ed",
      "ip" : "10.100.100.1/23",
      "name" : "Vlan100 10.100.100.1/23",
      "physicalIntfId" : "96635454-b2a8-4b69-a417-a7c84b3f59fb",
      "type" : "ipIntfs"
    }],
  "shortName" : "Boundary2"
}]
datamodel.SetInternetCloudIntfList("Internet1",intfs)

Returns

True or False

See also

SetInterfaceObject

SetInternetCloudProperty()

def netbrain.sysapi.datamodel.SetInternetCloudProperty	(		property_name,
			cloud_name,
			value
	)

set internet cloud property.

from v2.0 (2019-02-14)

Parameters

property_name	(string) property name
cloud_name	(string) internet cloud name
value

Returns

true or false

See also

SetDeviceProperty

SetModuleObject()

def netbrain.sysapi.datamodel.SetModuleObject	(		device_name,
			module_name,
			module_object
	)

update device's module object by module name.

Parameters

device_name	(string) device name
module_name	(string) module name
module_object	(dic) module object

Returns

True or False

SetModuleProperty()

def netbrain.sysapi.datamodel.SetModuleProperty	(		property_name,
			device_name,
			module_name,
			value
	)

Set module attribute.

Parameters

property_name	(string) property name
device_name	(string) device name
module_name	(string) module name
value

Returns

true or false

SetMPLSCloud()

def netbrain.sysapi.datamodel.SetMPLSCloud	(		cloudName,
			CEList,
			dynamicCondition,
			excludeCEList
	)

set MPLS cloud datas.

from v2.0 (2019-02-14)

Parameters

cloudName	(string) mpls cloud name
CEList	(list of object) all CE list, include static CE and dynamic CE.
dynamicCondition	(object) dynamic CE filters.
excludeCEList	(list of object) exclucde CE list, devices or interfaces

example

:
CEList=[{
  "ip" : "172.24.14.6/24",
  "ceNbrs" : [{
      "asNum" : 65535,
      "ceIfVpn" : "",
      "descr" : "Static",
      "devId" : "5ab3aa49-69bd-438e-be58-ca8bb467d944",
      "ceName" : "BJ-R3",
      "flag" : 0,
      "ifname" : "d367d36d-852d-4d6c-8455-a1ece3a5c6a8",
      "peIp" : "172.24.14.6/24",
      "ip" : "172.24.14.6/24",
      "ceIntfIP" : "172.24.14.4/24",
      "ceIntfName" : "FastEthernet0/1",
      "routingProtocol" : "",
      "groupType" : "Static",
      "ceVpn" : "55",
      "mplsId" : "4b8aa1e9-1ad1-7ba5-7692-89484eef26c0"
    }]
}]
dynamicCondition = {
    "RangeOption" : 0,
    "DeviceGroupRange" : [],
    "SiteRange" : [],
    "Filter" : {
      "Conditions" : [{
          "Schema" : "name",
          "Operator" : 4,
          "Expression" : "aaa"
        }, {
          "Schema" : "intfs.name",
          "Operator" : 4,
          "Expression" : "rrr"
        }, {
          "Schema" : "intfs.speed",
          "Operator" : 0,
          "Expression" : "1"
        }],
      "Expression" : "A and B and C"
    }
}
excludeCEList=[{
  "ip" : "172.24.14.31/24",
  "ceNbrs" : [{
      "asNum" : 65535,
      "ceIfVpn" : "",
      "descr" : "",
      "devId" : "b987b3e5-3689-4408-bf1a-69d77f2fd341",
      "ceName" : "BJ-R2",
      "flag" : 2,
      "ifname" : "26170cb8-2912-4155-b550-b15b4af65e8b",
      "peIp" : "172.24.14.31/24",
      "ip" : "172.24.14.31/24",
      "ceIntfIP" : "172.24.14.3/24",
      "ceIntfName" : "FastEthernet0/1",
      "routingProtocol" : "ISIS L1/L2",
      "ceVpn" : "1",
      "groupType" : "Excluded"
    }]
}]
ret = datamodel.SetMPLSCloud("Mpls2",CEList,dynamicCondition,excludeCEList)

SetMPLSCloudCEObjects()

def netbrain.sysapi.datamodel.SetMPLSCloudCEObjects	(		cloudName,
			ceNbrObjs,
			flag
	)

add or update Mpls CE .

from v2.0 (2019-02-14)

Parameters

cloudName	(string) mpls cloud name
ceNbrObjs	(list) mpls CE object.
flag	(int) 0:static CE,1:dyncmic CE,2:exclude CE. ceNbrObjs example: [{ 'asNum': 65535, 'ceIfVpn': '', 'ceIntfIP': '172.24.14.4/24', 'ceIntfName': 'FastEthernet0/1', 'ceName': 'BJ-R3', 'ceVpn': '55', 'descr': 'Static', 'devId': '5ab3aa49-69bd-438e-be58-ca8bb467d944', 'flag': 0, 'groupType': 'Static', 'ifname': 'd367d36d-852d-4d6c-8455-a1ece3a5c6a8', 'ip': '172.24.14.6/24', 'mplsId': '4b8aa1e9-1ad1-7ba5-7692-89484eef26c0', 'peIp': '172.24.14.6/24', 'routingProtocol': '' }]

SetMPLSCloudDynamicFilter()

def netbrain.sysapi.datamodel.SetMPLSCloudDynamicFilter	(		cloudName,
			filterCondition
	)

set the dynamic CE filter.

from v2.0 (2019-02-14)

Parameters

cloudName	(string) mpls cloud name
filterCondition	(object) dynamic CE filter object

Returns

(bool) True if success ex.

filterCondition={
  "DeviceGroupRange" : [],
  "Filter" : {
    "Conditions" : [{
        "Expression" : "R",
        "Operator" : 4,
        "Schema" : "name"
      }, {
        "Expression" : "10.25",
        "Operator" : 1,
        "Schema" : "mgmtIP"
      }],
    "Expression" : "A or B"
  },
  "RangeOption" : 0,
  "SiteRange" : []
}
ret =  datamodel.SetMPLSCloudDynamicFilter("Mpls2",filter)

SetMPLSCloudExcludeCEList()

def netbrain.sysapi.datamodel.SetMPLSCloudExcludeCEList	(		cloudName,
			CEList
	)

add or update Mpls Excluce CE List.

from v2.0 (2019-02-14)

Parameters

cloudName

(string) mpls cloud name

CEList

(list) mpls exclude CE object list. CEList example: [{ "asNum" : 65535, "ceIfVpn" : "", "ceIntfIP" : "10.10.7.254/22", "ceIntfName" : "Vlan20", "ceName" : "sw-4500-15", "ceVpn" : "3", "descr" : "", "devId" : "ebcfe2cb-0b7a-4f9a-8c79-dca3a0ce18ed", "flag" : 2, "groupType" : "Excluded", "ifname" : "dddf9a2e-a648-4c53-a625-f590ef76068c", "ip" : "10.10.7.242/22", "peIp" : "10.10.7.242/22", "routingProtocol" : "" }]

SetMPLSCloudProperty()

def netbrain.sysapi.datamodel.SetMPLSCloudProperty	(		propertyName,
			cloudName,
			value
	)

set mpls cloud property.

from v2.0 (2019-02-14)

Parameters

propertyName	(string) property name
cloudName	(string) mpls cloud name
value

Returns

true or false

See also

SetDeviceProperty

SetMPLSCloudStaticCE()

def netbrain.sysapi.datamodel.SetMPLSCloudStaticCE	(		cloudName,
			iPofPEinterface,
			cEDevice,
			cEInterface,
			VRF,
			routingProtocol,
			VPN
	)

SetNDTItem()

def netbrain.sysapi.datamodel.SetNDTItem

(

ndtItem

)

set NDT Item

Parameters

ndtItem

(dic) ndt item

example

:
AddNDTItem("device1", True, "1.2.3.4", "b2d313fe-43e6-4d5f-9189-b3af6b71a83a", 2)
ndtItems = datemodel.GetNDTItems()
for item in ndtItems:
   if item["_id"] == "30ce59d2-ba6e-47ff-800e-45a431738422" :
       item["devNameExp"] = "device2"
       item["isRegx"] = False
       item["ipAddrRange"] = "3.4.5.6"
       item["driverId"] = "b2d313fe-43e6-4d5f-9189-b3af6b71a83a"
       item["devSubType"] = 2
       datemodel.SetNDTItem(item)
       break

Returns

True or False

Return values

If	the parameter does not contain "_id", return false

SetProxyServerOfDevice()

def netbrain.sysapi.datamodel.SetProxyServerOfDevice	(		device_name,
			fsId
	)

Network settings APIs - SetProxyServerOfDevice.

Parameters

device_name	device name
fsId	fsId

Returns

True or False If return False, may be:

1. Can not find device setting by device name.
   
2. device is locked.
   
3. Can not find server by fsId.

SetPyLastError()

def netbrain.sysapi.datamodel.SetPyLastError	(		error,
			error_number = -1
	)

SetLastError.

Parameters

error	set thread local error
error_number	error number

SetSiteProperty()

def netbrain.sysapi.datamodel.SetSiteProperty	(		property_name,
			site_path,
			value
	)

set site property

Parameters

site_path	(string) site path
property_name	(string) property name
value	(string) property value

Returns

True or False

SubmitChildTask()

def netbrain.sysapi.datamodel.SubmitChildTask	(		task_name,
			task_param,
			wait_seconds = 0
	)

submit one child task to RMAgent

Parameters

task_name	(string) task name,ex.:"DeleteDevice"
task_param	(dict) task parameters.
wait_seconds	(int) seconds whitch wait the child task complete. if wait_seconds equal to zero. not wait the child task complete.

Returns

dict ,like {'result': True, 'taskId': '80a82cb9-53ef-4111-bded-1eda87430975'},if succes,result is True,else result is False.

example: we can rewrite the DeleteDevices function with native python

def DeleteDevices(device_names):
    query={"name":{"$in":device_names}}
    dev_ids = datamodel.QueryDeviceIds(query)
    param={}
    param["param"]=';'.join(dev_ids)
    ret = datamodel.SubmitChildTask("DeleteDevice",param,50)
    return ret["result"]

DeleteDevices(["NATT-R1","NATT-ISP"])

SubmitHostNameChangeChildTask()

def netbrain.sysapi.datamodel.SubmitHostNameChangeChildTask

(

)

TriggerEventTemplate()

def netbrain.sysapi.datamodel.TriggerEventTemplate	(		message,
			eventTemplateName = None
	)

trigger event templete

Note

Need to use API IsAnalysisTask in QApp live mode,otherwise it will be triggered twice.

Parameters

message	message
eventTemplateName	event driven templete name

Returns

True or False

example

    from netbrain.sysapi import datamodel
   Ticket = {
        "message" : "1111111111111111"
   }

   ret = datamodel.TriggerEventTemplate(Ticket)
   # or trigger event by specified templete name
   # ret = datamodel.TriggerEventTemplate(Ticket, 'New Template')
   if not ret :
       pluginfw.AddLog(str(datamodel.GetPyLastError()))
return ret

UpdateLayoutTagForDevs()

def netbrain.sysapi.datamodel.UpdateLayoutTagForDevs	(		devNames,
			tagNames
	)

Update LayoutTag For Devices.

Parameters

devNames	device name list
tagNames	tag name list

Returns

True or False

UpdateOnePhantomInterface()

def netbrain.sysapi.datamodel.UpdateOnePhantomInterface	(		device_name,
			interface_type,
			interface_object,
			get_new = False
	)

Update one interface of one device.

Parameters

device_name	(string) device name
interface_type	(string) interface type
interface_object	(dic) interface value. ex:{Interface object1}
get_new	(bool) Whether to use new data(When the interface data is modified in your script, it needs to be set to true in order to obtain the updated data)

Returns

True or False

UpdatePhantomInterfaces()

def netbrain.sysapi.datamodel.UpdatePhantomInterfaces	(		device_name,
			interface_type,
			interface_objects
	)

Update all interface of one device.

Attention

If interfaces_value is "[]", this func equal to ClearPhantomInterface

See also

ClearPhantomInterface

Parameters

device_name	(string) device name
interface_type	(string) interface type
interface_objects	(list) interfaces value. ex:[{Interface object1}, {Interface object2}, ....]

Returns

True or False

UpsertHostnameChangeList()

def netbrain.sysapi.datamodel.UpsertHostnameChangeList

(

host_name_list

)

update host name change list

Parameters

host_name_list

host name list.

See also

:GetHostnameChangeList

:KeepLastChangeDevice

Returns

Trur or False

ValidateDictElement()

def netbrain.sysapi.datamodel.ValidateDictElement	(		key,
			dictIns,
			valueType
	)

ValidateEmailJson()

def netbrain.sysapi.datamodel.ValidateEmailJson

(

emailInfo

)

Variable Documentation

CLOUD_STATIC_TYPE

int netbrain.sysapi.datamodel.CLOUD_STATIC_TYPE = 0

MPLS_CE_ACCESS_PNT_KEY

string netbrain.sysapi.datamodel.MPLS_CE_ACCESS_PNT_KEY = 'mpls_accessPnt'

MPLS_DYNYMIC_FILTER_KEY

string netbrain.sysapi.datamodel.MPLS_DYNYMIC_FILTER_KEY = 'deviceFilter'

MPLS_EXCLUDE_PNT_KEY

string netbrain.sysapi.datamodel.MPLS_EXCLUDE_PNT_KEY = 'exclude_accessPnt'

str_stack

netbrain.sysapi.datamodel.str_stack = traceback.format_exc()