Table of Contents

Method GetConnectivityConnection

Namespace
Skyline.DataMiner.Scripting
Assembly
SLManagedScripting.dll

GetConnectivityConnection(int, int, string, bool)

Retrieves the specified DCF connection.

ConnectivityConnection GetConnectivityConnection(int iDMAId, int iEId, string name, bool exported)

Parameters

iDMAId int

The DataMiner Agent ID of the element that holds the corresponding connection entry in the connections table.

iEId int

The element ID of the element that holds the corresponding connection entry in the connections table.

name string

The name of the connection.

exported bool

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

Returns

ConnectivityConnection

The DCF connection or null in case the connection was not found.

Examples

var connection = protocol.GetConnectivityConnection(400, 2000, "MyConnection", false);

Remarks

  • Feature introduced in DataMiner 8.5.8 (RN 10066).
  • The SLProtocol.GetConnectivityConnection method (Int32, Int32, string, Boolean) retrieves all connectivity connections for the specified element and then returns the connectivity connection with the specified name (if present). Therefore, if you need to request multiple connections, it can be more performant to request all connections using a single GetConnectivityConnections call and then extract the desired connections from the returned dictionary.

GetConnectivityConnection(int, int, string)

Retrieves the specified DCF connection.

ConnectivityConnection GetConnectivityConnection(int iDMAId, int iEId, string name)

Parameters

iDMAId int

The DataMiner Agent ID of the element that holds the corresponding connection entry in the connections table.

iEId int

The element ID of the element that holds the corresponding connection entry in the connections table.

name string

The name of the connection.

Returns

ConnectivityConnection

The DCF connection or null in case the connection was not found.

Examples

var connection = protocol.GetConnectivityConnection(400, 2000, "MyConnection");

Remarks

  • In the background, this call performs a GetConnectivityConnection(int DMAId, int Eid, string name, bool exported) call, with exported set to false.
  • The SLProtocol.GetConnectivityConnection method (Int32, Int32, string, Boolean) retrieves all connectivity connections for the specified element and then returns the connectivity connection with the specified name (if present). Therefore, if you need to request multiple connections, it can be more performant to request all connections using a single GetConnectivityConnections call and then extract the desired connections from the returned dictionary.

GetConnectivityConnection(int, int, int, bool)

Retrieves the specified DCF connection.

ConnectivityConnection GetConnectivityConnection(int iDMAId, int iEId, int iConnectionId, bool exported)

Parameters

iDMAId int

The DataMiner Agent ID of the element that holds the corresponding connection entry in the connections table.

iEId int

The element ID of the element that holds the corresponding connection entry in the connections table.

iConnectionId int

The ID of the connection.

exported bool

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

Returns

ConnectivityConnection

The DCF connection or null in case the connection was not found.

Examples

var connection = protocol.GetConnectivityConnection(400, 2000, 1, false);

Remarks

  • Feature introduced in DataMiner 8.5.8 (RN 10066).
  • The SLProtocol.GetConnectivityConnection method (Int32, Int32, Int32, Boolean) retrieves all connectivity connections for the specified element and then returns the connectivity connection with the specified ID (if present). Therefore, if you need to request multiple connections, it can be more performant to request all connections using a single GetConnectivityConnections call and then extract the desired connections from the returned dictionary.

GetConnectivityConnection(int, int, int)

Retrieves the specified DCF connection.

ConnectivityConnection GetConnectivityConnection(int iDMAId, int iEId, int iConnectionId)

Parameters

iDMAId int

The DataMiner Agent ID of the element that holds the corresponding connection entry in the connections table.

iEId int

The element ID of the element that holds the corresponding connection entry in the connections table.

iConnectionId int

The ID of the connection.

Returns

ConnectivityConnection

The DCF connection or null in case the connection was not found.

Examples

var connection = protocol.GetConnectivityConnection(400, 2000, 1);

Remarks

  • In the background, this call performs a GetConnectivityConnection(int DMAId, int Eid, int connectionId, bool exported) call, with exported set to false.
  • The SLProtocol.GetConnectivityConnection method (Int32, Int32, Int32, Boolean) retrieves all connectivity connections for the specified element and then returns the connectivity connection with the specified ID (if present). Therefore, if you need to request multiple connections, it can be more performant to request all connections using a single GetConnectivityConnections call and then extract the desired connections from the returned dictionary.
Propose changes