Method GetConnectivityInterface

Namespace

Skyline.DataMiner.Scripting

Assembly

SLManagedScripting.dll

GetConnectivityInterface(int, int, string, bool, bool)

Retrieves the specified DCF interface.

ConnectivityInterface GetConnectivityInterface(int iDMAId, int iEId, string name, bool customName, bool exported)

Parameters

iDMAId int

The DataMiner Agent ID of the element.

iEId int

The element ID of the element.

name string

The name of the interface.

customName bool

true if the name specified in name is the custom interface name; otherwise, false.

exported bool

true to include interfaces of DVE children; otherwise, false.

Returns

ConnectivityInterface

The specified interface or null in case the interface was not found.

Examples

var myInterface = protocol.GetConnectivityInterface(400, 2000, "MyInterface", true, true);

Remarks

• Feature introduced in DataMiner 8.5.8 (RN 10066).
• The SLProtocol.GetConnectivityInterface method (Int32, Int32, string, Boolean, Boolean) retrieves all connectivity interfaces for the specified element (including interfaces of DVE children if exported is true) and then returns the connectivity interface with the specified name (if present). Therefore, if you need to request multiple interfaces, it can be more performant to request all interfaces using a GetConnectivityInterfaces call and extract the desired interfaces from the returned dictionary.

GetConnectivityInterface(int, int, string, bool)

Retrieves the specified DCF interface.

ConnectivityInterface GetConnectivityInterface(int iDMAId, int iEId, string name, bool customName)

Parameters

iDMAId int

The DataMiner Agent ID of the element.

iEId int

The element ID of the element.

name string

The name of the interface.

customName bool

true if the name specified in name is the custom interface name; otherwise, false.

Returns

ConnectivityInterface

The specified DCF interface or null in case the interface was not found.

Examples

var myInterface = protocol.GetConnectivityInterface(400, 2000, "MyInterface", true);

Remarks

• In the background, this call performs a GetConnectivityInterface(int DMAId, int Eid, string name, bool customName, bool exported) call with exported set to false.
• The SLProtocol.GetConnectivityInterface method (Int32, Int32, string, Boolean, Boolean) retrieves all connectivity interfaces for the specified element (including interfaces of DVE children if exported is true) and then returns the connectivity interface with the specified name (if present). Therefore, if you need to request multiple interfaces, it can be more performant to request all interfaces using a GetConnectivityInterfaces call and extract the desired interfaces from the returned dictionary.

GetConnectivityInterface(int, int, int, bool)

Retrieves the specified DCF interface.

ConnectivityInterface GetConnectivityInterface(int iDMAId, int iEId, int iItfId, bool exported)

Parameters

iDMAId int

The DataMiner Agent ID of the element the interface is part of.

iEId int

The element ID of the element the interface is part of.

iItfId int

The ID of the interface.

exported bool

true to include interfaces of DVE children; otherwise, false.

Returns

ConnectivityInterface

The specified interface or null in case the specified interface was not found.

Examples

var myInterface = protocol.GetConnectivityInterface(400, 2000, 1, true);

Remarks

• Feature introduced in DataMiner 8.5.8 (RN 10066).
• The SLProtocol.GetConnectivityInterface method (Int32, Int32, Int32, Boolean) retrieves all connectivity interfaces for the specified element (including interfaces of DVE children if exported is true) and then returns the connectivity interface with the specified ID (if present). Therefore, if you need to request multiple interfaces, it can be more performant to request all interfaces using a single GetConnectivityInterfaces call and then extract the desired interfaces from the returned dictionary.

GetConnectivityInterface(int, int, int)

Retrieves the specified DCF interface.

ConnectivityInterface GetConnectivityInterface(int iDMAId, int iEId, int iItfId)

Parameters

iDMAId int

The DataMiner Agent ID of the element.

iEId int

The element ID of the element.

iItfId int

The ID of the interface.

Returns

ConnectivityInterface

The specified DCF interface or null in case the interface was not found.

Examples

var myInterface = protocol.GetConnectivityInterface(400, 2000, 1);

Remarks

• In the background, this call performs a GetConnectivityInterface(int DMAId, int Eid, int ItfId, bool exported) call, with exported set to false.
• The SLProtocol.GetConnectivityInterface method (Int32, Int32, Int32, Boolean) retrieves all connectivity interfaces for the specified element (including interfaces of DVE children if exported is true) and then returns the connectivity interface with the specified ID (if present). Therefore, if you need to request multiple interfaces, it can be more performant to request all interfaces using a single GetConnectivityInterfaces call and then extract the desired interfaces from the returned dictionary.