api for device & interface More...

Functions
def	netbrain.sysapi.datamodel.QueryDeviceObjects (query)
	query device object More...

def	netbrain.sysapi.datamodel.QueryDeviceIds (query)
	query device id list by query More...

def	netbrain.sysapi.datamodel.SetDeviceObject (device, deviceObj)
	set device object More...

def	netbrain.sysapi.datamodel.AddDeviceObject (deviceObj)
	Add device object. More...

def	netbrain.sysapi.datamodel.GetDeviceObject (device)
	Get device object by device name. More...

def	netbrain.sysapi.datamodel.GetDeviceObjectById (devId)
	Get device object by device id. More...

def	netbrain.sysapi.datamodel.GetDeviceNameFromIp (strIp)
	Get device name by IP(interface ips.ip) More...

def	netbrain.sysapi.datamodel.SetDeviceProperty (property_name, device_name, value)
	Set device property. More...

def	netbrain.sysapi.datamodel.GetDeviceProperty (property_name, device_name)
	Get device property. More...

def	netbrain.sysapi.datamodel.QueryInterfaceIds (query, intf_type)
	Get interface id list by intf type. More...

def	netbrain.sysapi.datamodel.QueryInterfaceObjects (query, intf_type)
	Get interface id list by intf type. More...

def	netbrain.sysapi.datamodel.SetInterfaceObject (device, intf_name, intf_type, intf_object)
	Set interface object. More...

def	netbrain.sysapi.datamodel.GetInterfaceObject (device, intf_name, intf_type)
	Get interface object by device name, interface name. More...

def	netbrain.sysapi.datamodel.GetInterfaceObjectById (intf_id, intf_type)
	Get interface object by interface id. More...

def	netbrain.sysapi.datamodel.GetInterfaceIdsByDeviceName (device, intf_type)
	Get interface id list by device name. More...

def	netbrain.sysapi.datamodel.GetDeviceInterfaceId (device, phantom_interface_name, phantom_interface_type)
	Get interface id by device name, interface name, interface type. More...

def	netbrain.sysapi.datamodel.GetPhantomInterfaceIds (device, device_interface_name, phantom_interface_type)
	Get phantom interface id by device name, interface name, interface type. More...

def	netbrain.sysapi.datamodel.GetInterfaceIdsByType (intf_type)
	Get interface id list by interface type. More...

def	netbrain.sysapi.datamodel.SetInterfaceProperty (property_name, device, intf_name, intf_type, value)
	Set interface attribute. More...

def	netbrain.sysapi.datamodel.SetInterfacePropertyById (property_name, intf_id, intf_type, value)
	Set interface attribute by Id. More...

def	netbrain.sysapi.datamodel.GetInterfaceProperty (property_name, device, intf_name, intf_type)
	Get interface attribute. More...

def	netbrain.sysapi.datamodel.AddPhantomInterface (device_name, interface_name, interface_type, belongs_to_topology_type)
	Add phantom interface. More...

def	netbrain.sysapi.datamodel.RemovePhantomInterface (device_name, interface_name, interface_type)
	Remove phantom interface. More...

def	netbrain.sysapi.datamodel.UpdateOnePhantomInterface (device_name, interface_type, interface_object)
	Update one interface of one device. More...

def	netbrain.sysapi.datamodel.UpdatePhantomInterfaces (device_name, interface_type, interface_objects)
	Update all interface of one device. More...

def	netbrain.sysapi.datamodel.ClearPhantomInterface (device_name, interface_type)
	delete all the intf of the device More...

def	netbrain.sysapi.datamodel.GetInterfaceShortName (device_name, interface_name)
	get interface short name More...

def	netbrain.sysapi.datamodel.CompleteInterfaceName (device_name, interface_name)
	get interface full name More...

def	netbrain.sysapi.datamodel.SetModuleObject (device_name, module_name, module_object)
	update device's module object by module name. More...

def	netbrain.sysapi.datamodel.GetModuleObject (device_name, module_name)
	get device's module object by module name. More...

def	netbrain.sysapi.datamodel.SetModuleProperty (property_name, device_name, module_name, value)
	Set module attribute. More...

def	netbrain.sysapi.datamodel.GetModuleProperty (property_name, device_name, module_name)
	Get module attribute. More...

def	netbrain.sysapi.datamodel.GetMemberInterfaceIdsBelong2Channel (device, intf)
	get member interface ids Belong2Channel More...

def	netbrain.sysapi.datamodel.SetInternetCloud (cloud_name, value)
	set internet cloud object. More...

def	netbrain.sysapi.datamodel.GetInternetCloud (cloud_name)
	get internet cloud. More...

def	netbrain.sysapi.datamodel.SetInternetCloudProperty (property_name, cloud_name, value)
	set internet cloud property. More...

def	netbrain.sysapi.datamodel.GetInternetCloudProperty (property_name, cloud_name)
	get internet cloud property. More...

def	netbrain.sysapi.datamodel.SetInternetCloudIntfList (cloudName, boudaryInterfaceList)
	set internet cloud interface list. More...

def	netbrain.sysapi.datamodel.RemoveInternetCloudInterface (cloudName, interfaceName)
	Remove internet cloud interface,from v2.1 (2019-03-04) More...

def	netbrain.sysapi.datamodel.ClearInternetCloudIntfList (cloudName)
	delete all the intf of the internet cloud ,from v2.1 (2019-03-04) More...

def	netbrain.sysapi.datamodel.GetInternetCloudIntfList (cloudName)
	get internet cloud interface list. More...

def	netbrain.sysapi.datamodel.SetMPLSCloudProperty (propertyName, cloudName, value)
	set mpls cloud property. More...

def	netbrain.sysapi.datamodel.GetMPLSCloudProperty (propertyName, cloudName)
	get mpls cloud property. More...

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

def	netbrain.sysapi.datamodel.GetMPLSCloud (cloudName)

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

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

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

def	netbrain.sysapi.datamodel.SetMPLSCloudDynamicFilter (cloudName, filterCondition)
	set the dynamic CE filter. More...

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

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

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

def	netbrain.sysapi.datamodel.DeleteMPLSCloud (cloudName)

def	netbrain.sysapi.datamodel.GetMacDevicesByMac (mac)
	get mac device by mac More...

def	netbrain.sysapi.datamodel.DeleteMacDeviceByMac (mac)
	delete mac device by mac More...

def	netbrain.sysapi.datamodel.DeleteMacDeviceById (id)
	delete mac device by id More...

Detailed Description

api for device & interface

Function Documentation

◆ AddDeviceObject()

def netbrain.sysapi.datamodel.AddDeviceObject ( deviceObj )

Add device object.

Parameters

deviceObj device object

◆ AddPhantomInterface()

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

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

Returns: True or False

◆ 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

Returns: True or False

See also: ClearPhantomInterface

◆ 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

◆ 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

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

◆ GetDeviceInterfaceId()

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

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,

Returns: interface id

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

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

Returns: interface object dic

◆ GetInterfaceObjectById()

def netbrain.sysapi.datamodel.GetInterfaceObjectById	(	intf_id,
		intf_type
	)

Get interface object by interface id.

Parameters

intf_id	(string) interface id
intf_type	(string) interface type - intfs, ipIntfs, ip6Intfs, greVpnIntfs, ipsecVpnIntfs,

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

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

◆ GetMPLSCloudDynamicCEList()

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

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

◆ 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} ]

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

◆ RemoveInternetCloudInterface()

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

Remove internet cloud interface,from v2.1 (2019-03-04)

Parameters

cloudName	(string) internet cloud name
interfaceName	(string) interface name

Returns: True or False

See also: RemovePhantomInterface

◆ 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

◆ 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

◆ SetInterfaceObject()

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

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

Returns: true or false

◆ SetInterfaceProperty()

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

Set interface attribute.

Parameters

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

Returns: true or false

◆ SetInterfacePropertyById()

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

Set interface attribute by Id.

Parameters

property_name	(string) property name
intf_type	(string) interface type
intf_id	(string) interface id
value

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.

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
	)

◆ SetMPLSCloudCEObjects()

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

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

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

◆ UpdateOnePhantomInterface()

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

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}

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

Functions

Detailed Description

Function Documentation

◆ AddDeviceObject()

◆ AddPhantomInterface()

◆ ClearInternetCloudIntfList()

◆ ClearPhantomInterface()

◆ CompleteInterfaceName()

◆ DeleteMacDeviceById()

◆ DeleteMacDeviceByMac()

◆ DeleteMPLSCloud()

◆ GetDeviceInterfaceId()

◆ GetDeviceNameFromIp()

◆ GetDeviceObject()

◆ GetDeviceObjectById()

◆ GetDeviceProperty()

◆ GetInterfaceIdsByDeviceName()

◆ GetInterfaceIdsByType()

◆ GetInterfaceObject()

◆ GetInterfaceObjectById()

◆ GetInterfaceProperty()

◆ GetInterfaceShortName()

◆ GetInternetCloud()

◆ GetInternetCloudIntfList()

◆ GetInternetCloudProperty()

◆ GetMacDevicesByMac()

◆ GetMemberInterfaceIdsBelong2Channel()

◆ GetModuleObject()

◆ GetModuleProperty()

◆ GetMPLSCloud()

◆ GetMPLSCloudDynamicCEList()

◆ GetMPLSCloudExcludeCEList()

◆ GetMPLSCloudProperty()

◆ GetMPLSCloudStaticCEList()

◆ GetPhantomInterfaceIds()

◆ QueryDeviceIds()

◆ QueryDeviceObjects()

◆ QueryInterfaceIds()

◆ QueryInterfaceObjects()

◆ RemoveInternetCloudInterface()

◆ RemovePhantomInterface()

◆ SetDeviceObject()

◆ SetDeviceProperty()

◆ SetInterfaceObject()

◆ SetInterfaceProperty()

◆ SetInterfacePropertyById()

◆ SetInternetCloud()

◆ SetInternetCloudIntfList()

◆ SetInternetCloudProperty()

◆ SetModuleObject()

◆ SetModuleProperty()

◆ SetMPLSCloud()

◆ SetMPLSCloudCEObjects()

◆ SetMPLSCloudDynamicFilter()

◆ SetMPLSCloudExcludeCEList()

◆ SetMPLSCloudProperty()

◆ SetMPLSCloudStaticCE()

◆ UpdateOnePhantomInterface()

◆ UpdatePhantomInterfaces()