NT_CREATE_ELEMENT (160)
Creates an element on the specified DMA.
string elementName = "CISCO Meraki Main";
int dmaId = 400;
object[] elementDetails = new object[] { elementName, dmaId };
string elementSettings = "…";
int result = (int) protocol.NotifyDataMinerQueued(160 /* NT_CREATE_ELEMENT */, elementDetails, elementSettings);
Parameters
- elementDetails (object[]):
- elementDetails[0]: (string) Name of the element to be created.
- elementDetails[1]: (int) ID of the DataMiner Agent on which the element has to be created.
- elementSettings (string): String defining the element configuration options.
Return Value
- (int): 0 indicates the operation succeeded.
Remarks
Instead of providing elementDetails (object[), it is also possible to only specify the element name:
string elementName = "CISCO Meraki Main"; string elementSettings = "…"; int result = (int) protocol.NotifyDataMinerQueued(160 /* NT_CREATE_ELEMENT */, elementName, elementSettings);Before DVE functionality existed, elements were created from within a QAction using different protocols. To create an element, you can pass several element options to the NotifyDataMinerQueued type 160 method call as a pipe-separated ('|') string. The following table contains an overview of the different settings that can be provided along with the position in the string.
Position Description 0 Name 1 State (supported values: "Active", "Inactive", "Stop") 2 Data 3 Unique 4 Protocol name 5 Protocol version 6 Template name 7 Port type*: None, IP, UDP or Serial 8 Port number* 9 Port baud rate* 10 Port parity* (In case of an SNMPv3 connection, this field denotes the authentication algorithm e.g. "HMAC-SHA".) 11 Port data bits* (In case of an SNMPv3 connection, this field denotes the user name.) 12 Port stop bits* (In case of an SNMPv3 connection, this field denotes whether authentication and privacy is enabled e..g. "authPriv".) 13 Port flow control* (In case of an SNMPv3 connection, this field denotes the privacy algorithm.) 14 Port bus* 15 Retries* 16 Slow poll base* 17 Timeout* 18 Slow poll value* 19 Polling IP* 20 Polling IP port* 21 Ping interval* 22 SNMP Agent IP Address 23 SNMP Agent subnet mask 24 Telnet 25 SNMP Agent 26 Description 27 Element timeout* Note: Set this to -1 in case you want to exclude the timeout state of this connection from the overall element state. 28 Get community* (In case of an SNMPv3 connection, this field denotes the authentication password.) 29 Set community* (In case of an SNMPv3 connection, this field denotes the privacy password.) 30 Type 31 Hidden 32 Trend template 33 Service 34 Local IP port* 35 read only 36 Replication: active 37 Replication: options 38 Replication: remote element 39 Replication: DataMiner IP 40 Replication: user name 41 Replication: password 42 Replication: domain 43 Keep online: true/false (Failover) 44 Force agent: empty/IP address (Failover) 45 Replication: DMP manager populated 46 DMA SNMP Agent get community string 47 DMA SNMP Agent set community string 48 DVE creation flag 49 Replication: max messages to buffer 50 Replication: max minutes to buffer 51 Protocol type*, ** 52 Library credential* *: Indicates a connection setting field. When an element is created from a protocol that has multiple connections defined, these fields contain multiple values separated by tabs (“\t”).
**: Protocol types:
- 1: SNMP
- 2: Serial
- 3: Smart-serial
- 4: Virtual
- 5: GPIB
- 6: OPC
- 7: SLA
- 8: SNMPv2
- 9: SNMPv3
- 10: HTTP
- 11: Service
- 12: Serial single
- 13: Smart-serial single
- 16: WebSocket
E.g. creating an element with 2 HTTP connections will require a protocol type field value of "10\t10".
The following example creates an element running an SNMPv3 protocol:
private static void CreateElement(SLProtocol protocol, string elementName, string protocolName, string protocolVersion, string pollingIP, string pollingPort, string busAddress) { string[] settings = new string[53]; settings[0] = elementName; // Element name settings[1] = "Active"; // State settings[2] = String.Empty; // data settings[3] = String.Empty; // unique settings[4] = protocolName; // protocol name settings[5] = protocolVersion; // protocol version settings[6] = String.Empty; // template name settings[7] = "IP"; // port type settings[8] = "0"; // port number settings[9] = String.Empty; // port Baud rate settings[10] = "HMAC-SHA"; // parity settings[11] = "User0"; // data bits settings[12] = "authPriv"; // stop bits settings[13] = "DES"; // flow control settings[14] = busAddress; // port bus settings[15] = "3"; // retries settings[16] = String.Empty; // slowPollBase settings[17] = "1500"; // timeout settings[18] = "30000"; // Slow poll value. settings[19] = pollingIp; // Polling IP settings[20] = pollingPort; // Polling IP port settings[21] = "30000"; // Ping interval. settings[22] = "127.0.0.2"; // SNMP Agent IP address settings[23] = String.Empty; // SNMP Agent subnet mask settings[24] = "0"; // Telnet settings[25] = "0"; // SNMP Agent settings[26] = String.Empty; // Description settings[27] = "-1"; // Element timeout settings[28] = "AuthAuth0"; // Get community settings[29] = "PrivPriv0"; // Set community settings[30] = String.Empty; // Type settings[31] = "False"; // Hidden settings[32] = String.Empty; // Trend template settings[33] = "False"; // Service settings[34] = String.Empty; // Local IP port settings[35] = String.Empty; // read only settings[36] = String.Empty; // Replication: active settings[37] = String.Empty; // Replication: options settings[38] = String.Empty; // Replication: remote element settings[39] = String.Empty; // Replication: DataMiner IP settings[40] = String.Empty; // Replication: user name settings[41] = String.Empty; // Replication: password settings[42] = String.Empty; // Replication: domain settings[43] = String.Empty; // Keep online: true/false (failover) settings[44] = String.Empty; // Force agent: empty/IP address (failover) settings[45] = String.Empty; // Replication: DMP manager populated settings[46] = String.Empty; // DMA SNMP Agent get community string settings[47] = String.Empty; // DMA SNMP Agent set community string settings[48] = String.Empty; // DVE creation flag settings[49] = String.Empty; // Replication: max messages to buffer settings[50] = String.Empty; // Replication: max minutes to buffer settings[51] = "9"; // Protocol type settings[52] = String.Empty; // Library credential string elementConfigurationSettings = String.Join("|", settings); protocol.NotifyDataMinerQueued(160 /* NT_CREATE_ELEMENT */, elementName, elementConfigurationSettings); }Before creating an element, make sure the element name is not already used and that there is not already an element using the same polling IP/bus.
Check if the element name is already used:
object elementID = null; DMSClass dms = new DMSClass(); dms.Notify(72 /* DMS_GET_ELEMENT_ID */, 0, elementName, null, out elementID); protocol.Log("ID of element with name "+elementName+": " + elementID, LogType.Error, LogLevel.NoLogging);Check if there is already an element that is using the same polling IP/bus:
object elementID = null; string[] connectionSettings = new string[] { ipAddress, busAddress }; dms.Notify(76, 0, connectionSettings, null, out elementID); protocol.Log("Element that has the same IP and bus: " + elementID, LogType.Error, LogLevel.NoLogging);