api for System maintaince More...

Functions
def	netbrain.sysapi.datamodel.GetSchemaType (schema_name)
	get schema type by schema name More...

def	netbrain.sysapi.datamodel.SetDeviceCredential (device_name, username, password, privilege_username, privilege_password, access_mode=0, port=0)
	Network settings APIs - SetDeviceCredential. More...

def	netbrain.sysapi.datamodel.GetProxyServerStatus (fsId)
	Network settings APIs - GetProxyServerStatus. More...

def	netbrain.sysapi.datamodel.SetProxyServerOfDevice (device_name, fsId)
	Network settings APIs - SetProxyServerOfDevice. More...

def	netbrain.sysapi.datamodel.GetDeviceSetting (device)
	Get device setting. More...

def	netbrain.sysapi.datamodel.SetDeviceSetting (device_setting_object)
	Set device setting. More...

def	netbrain.sysapi.datamodel.GetAllPhantomInterfaceTypes ()
	get all phantom interface types More...

def	netbrain.sysapi.datamodel.FindVendorByMAC (mac)
	find vendor by mac More...

def	netbrain.sysapi.datamodel.GetVendorModel (sysoid)
	get vendor model More...

def	netbrain.sysapi.datamodel.GetCurrentDomainInfo ()

def	netbrain.sysapi.datamodel.GetDeviceMACInfo (filter_list)
	get mac info More...

def	netbrain.sysapi.datamodel.GetDeviceSiteName (device)
	get device site name More...

def	netbrain.sysapi.datamodel.GetDeviceSiteFullPath (device)
	get device site full path More...

def	netbrain.sysapi.datamodel.GetDeviceIdsFromSite (site_path, include_child=False)
	get device ids from site More...

def	netbrain.sysapi.datamodel.AddDevicesToSite (site_path, device_ids)
	add devices to site More...

def	netbrain.sysapi.datamodel.RemoveDevicersFromSite (siteh_path, device_ids)
	– func unrealized More...

def	netbrain.sysapi.datamodel.ClearDevicesInSite (siteh_path)
	– func unrealized More...

def	netbrain.sysapi.datamodel.GetSiteProperty (property_name, site_path)
	get site property More...

def	netbrain.sysapi.datamodel.SetSiteProperty (property_name, site_path, value)
	set site property More...

def	netbrain.sysapi.datamodel.CreateDeviceGroup (device_group_name, device_group_type)
	create device group More...

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

def	netbrain.sysapi.datamodel.AddDevicesToDeviceGroup (devices, device_group_name, isStatic=True, deviceGroupType=0)
	add devices to device group More...

def	netbrain.sysapi.datamodel.RemoveDeviceFromDeviceGroup (device, device_group_name)
	remove device from device group More...

def	netbrain.sysapi.datamodel.ClearDevicesInDeviceGroup (device_group_name)
	clear device from device group More...

def	netbrain.sysapi.datamodel.GetDeviceIdsFromDeviceGroup (device_group_name)
	get device ids from device group More...

def	netbrain.sysapi.datamodel.GetCurrentMapId ()
	get current map id More...

def	netbrain.sysapi.datamodel.GetCurrentMapPageId ()
	get current map page id More...

def	netbrain.sysapi.datamodel.GetCurrentRunbookID ()
	get current runbook id More...

def	netbrain.sysapi.datamodel.GetRunbookTemplete (runbook_templete_path)
	get runbook templete by path More...

def	netbrain.sysapi.datamodel.GetQappInfo (qapp_path)
	get qapp content by path More...

def	netbrain.sysapi.datamodel.GetDataViewTemplete (dvt_path)
	get dvt by path More...

def	netbrain.sysapi.datamodel.SaveDataToDB (db, collection, value)
	save json to mongodb More...

def	netbrain.sysapi.datamodel.QueryDataFromDB (db, collection, json_value)
	query data from db More...

def	netbrain.sysapi.datamodel.GetDriverIdBySysOID (sysObjectID)

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

def	netbrain.sysapi.datamodel.AddNDTItem (devNameExp, isRegex, ipAddrRange, driverId, subType)
	add Network Definition More...

def	netbrain.sysapi.datamodel.GetNDTItems ()
	return all NDT Items More...

def	netbrain.sysapi.datamodel.SetNDTItem (ndtItem)
	set NDT Item More...

Detailed Description

api for System maintaince

Function Documentation

◆ 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

◆ 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

◆ ClearDevicesInDeviceGroup()

def netbrain.sysapi.datamodel.ClearDevicesInDeviceGroup ( device_group_name )

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

Returns: True or False

◆ ClearDevicesInSite()

def netbrain.sysapi.datamodel.ClearDevicesInSite ( siteh_path )

– func unrealized

Warning: func unrealized

◆ 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

◆ FindVendorByMAC()

def netbrain.sysapi.datamodel.FindVendorByMAC ( mac )

find vendor by mac

Parameters

mac	(string) mac

Returns: vendor string

◆ GetAllPhantomInterfaceTypes()

def netbrain.sysapi.datamodel.GetAllPhantomInterfaceTypes ( )

get all phantom interface types

Returns: interface types

Return values

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

◆ GetCurrentDomainInfo()

def netbrain.sysapi.datamodel.GetCurrentDomainInfo ( )

◆ 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 )

get device ids from device group

Parameters

device_group_name (string) device group name

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", ...]

◆ 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"], [...], ...]

◆ 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)

◆ GetDriverIdBySysOID()

def netbrain.sysapi.datamodel.GetDriverIdBySysOID ( sysObjectID )

◆ GetDriverIdByVendorModel()

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

◆ GetNDTItems()

def netbrain.sysapi.datamodel.GetNDTItems ( )

return all NDT Items

Returns: all NDT Item

Return values

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

◆ 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.

◆ 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"

◆ 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)

◆ GetVendorModel()

def netbrain.sysapi.datamodel.GetVendorModel ( sysoid )

get vendor model

Parameters

sysoid (string) oid

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

◆ QueryDataFromDB()

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

query data from db

Warning: this func can query all the db data.

◆ RemoveDeviceFromDeviceGroup()

def netbrain.sysapi.datamodel.RemoveDeviceFromDeviceGroup	(	device,
		device_group_name
	)

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

Returns: True or False

◆ RemoveDevicersFromSite()

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

– func unrealized

Warning: func unrealized

◆ SaveDataToDB()

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

save json to mongodb

Warning: this func can update all the db data.

◆ 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.

◆ SetDeviceSetting()

def netbrain.sysapi.datamodel.SetDeviceSetting ( device_setting_object )

Set device setting.

Parameters

device_setting_object device setting object

Returns: True or False

◆ 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:

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

◆ 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

Functions

Detailed Description

Function Documentation

◆ AddDevicesToDeviceGroup()

◆ AddDevicesToSite()

◆ AddDeviceToDeviceGroup()

◆ AddNDTItem()

◆ ClearDevicesInDeviceGroup()

◆ ClearDevicesInSite()

◆ CreateDeviceGroup()

◆ FindVendorByMAC()

◆ GetAllPhantomInterfaceTypes()

◆ GetCurrentDomainInfo()

◆ GetCurrentMapId()

◆ GetCurrentMapPageId()

◆ GetCurrentRunbookID()

◆ GetDataViewTemplete()

◆ GetDeviceIdsFromDeviceGroup()

◆ GetDeviceIdsFromSite()

◆ GetDeviceMACInfo()

◆ GetDeviceSetting()

◆ GetDeviceSiteFullPath()

◆ GetDeviceSiteName()

◆ GetDriverIdBySysOID()

◆ GetDriverIdByVendorModel()

◆ GetNDTItems()

◆ GetProxyServerStatus()

◆ GetQappInfo()

◆ GetRunbookTemplete()

◆ GetSchemaType()

◆ GetSiteProperty()

◆ GetVendorModel()

◆ QueryDataFromDB()

◆ RemoveDeviceFromDeviceGroup()

◆ RemoveDevicersFromSite()

◆ SaveDataToDB()

◆ SetDeviceCredential()

◆ SetDeviceSetting()

◆ SetNDTItem()

◆ SetProxyServerOfDevice()

◆ SetSiteProperty()