Skip to content

Commit 1c497f7

Browse files
PedroDebeverePedroDebevere
committed
added element creation documentation
1 parent 494f040 commit 1c497f7

File tree

2 files changed

+143
-0
lines changed

2 files changed

+143
-0
lines changed

‎develop/devguide/ClassLibrary/ClassLibraryElementCreation.md

+141
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,141 @@
1+
---
2+
uid: ClassLibraryElementCreation
3+
---
4+
5+
# Element creation
6+
7+
## Introduction
8+
9+
This section provides more information on how to create elements using the class library.
10+
11+
To create an element, use the [CreateElement](xref:Skyline.DataMiner.Library.Common.IDma.CreateElement(Skyline.DataMiner.Library.Common.ElementConfiguration)) method of the [IDma](xref:Skyline.DataMiner.Library.Common.IDma) interface.
12+
This method takes an [ElementConfiguration](xref:Skyline.DataMiner.Library.Common.ElementConfiguration) object as parameter, where you can configure the element settings for the element.
13+
14+
The ElementConfiguration constructors require the element name and the protocol to be specified.
15+
Other configuration settings can be specified via the properties of the ElementConfiguration object:
16+
17+
- [AdvancedSettings](xref:Skyline.DataMiner.Library.Common.ElementConfiguration.AdvancedSettings): Allows configuring advanced element settings such as the timeout, whether the element is hidden, etc.
18+
- [AlarmTemplate](xref:Skyline.DataMiner.Library.Common.ElementConfiguration.AlarmTemplate): Allows specifying an alarm template to be used.
19+
- [Connections](xref:Skyline.DataMiner.Library.Common.ElementConfiguration.Connections): Allows specifying the connections, if any. See <xref:ClassLibraryElementCreation#creating-an-element-with-connections>.
20+
- [Description](xref:Skyline.DataMiner.Library.Common.ElementConfiguration.Description): Allows providing a description for the element.
21+
- [DveSettings](xref:Skyline.DataMiner.Library.Common.ElementConfiguration.DveSettings): Allows configuring DVE-related settings such as whether DVE creation is enabled or disabled.
22+
- [Properties](xref:Skyline.DataMiner.Library.Common.ElementConfiguration.Properties): Allows configuring element properties. See <xref:ClassLibraryElementCreation#creating-an-element-with-properties>.
23+
- [State](xref:Skyline.DataMiner.Library.Common.ElementConfiguration.State): Allows configuring the state. Must be either Active, Paused or Stopped.
24+
- [TrendTemplate](xref:Skyline.DataMiner.Library.Common.ElementConfiguration.TrendTemplate): Allows specifying an alarm template to be used.
25+
- [Type](xref:Skyline.DataMiner.Library.Common.ElementConfiguration.Type): Allows specifying the type.
26+
- [Views](xref:Skyline.DataMiner.Library.Common.ElementConfiguration.Views): Allows specifying the views the created element should be part of. See <xref:ClassLibraryElementCreation#creating-an-element-in-specific-views>.
27+
28+
## Creating an element with properties
29+
30+
The following example illustrates how to create an element with some element properties:
31+
32+
```csharp
33+
IDms dms = protocol.GetDms();
34+
var agent = dms.GetAgent(1000);
35+
36+
IDmsProtocol elementProtocol = dms.GetProtocol("<ProtocolName>", "1.0.0.1");
37+
string elementName = "<ElementName>";
38+
39+
ElementConfiguration configuration = new ElementConfiguration(dms, elementName, elementProtocol);
40+
configuration.Properties["Manufacturer"].Value = "<manufacturerValue>";
41+
configuration.Properties["Model"].Value = "<modelValue>";
42+
43+
DmsElementId id = agent.CreateElement(configuration);
44+
```
45+
46+
## Creating an element in specific views
47+
48+
The following example illustrates how to create an element that should be included in the specified views:
49+
50+
```csharp
51+
IDms dms = protocol.GetDms();
52+
var agent = dms.GetAgent(1000);
53+
54+
IDmsProtocol elementProtocol = dms.GetProtocol("<ProtocolName>", "1.0.0.1");
55+
string elementName = "<ElementName>";
56+
57+
ElementConfiguration configuration = new ElementConfiguration(dms, elementName, elementProtocol);
58+
59+
configuration.Views.Add(dms.GetView(7));
60+
configuration.Views.Add(dms.GetView(9));
61+
62+
DmsElementId id = agent.CreateElement(configuration);
63+
```
64+
65+
## Creating an element with connections
66+
67+
In version 1.2.0.5 of the class library, support has been added for HTTP connections of elements (virtual and SNMP connections were already supported in previous versions). The following diagram gives an overview of the provided interfaces:
68+
69+
![alt text](../../images/classlibrary1205_1.png "Connections class diagram")
70+
71+
### Creating an SNMPv1 element
72+
73+
```csharp
74+
IDms dms = protocol.GetDms();
75+
IDma agent = dms.GetAgent(1000); // Obtain Agent where the element should be created.
76+
IDmsProtocol protocol = dms.GetProtocol("<ProtocolName>", "1.0.0.1"); // Specify the protocol the element will run.
77+
78+
IUdp port = new Udp("127.0.0.1", 161); // Configure the SNMP connection.
79+
80+
ISnmpV1Connection mySnmpV1Connection = new SnmpV1Connection(port);
81+
82+
ElementConfiguration configuration = new ElementConfiguration(dms, "<ElementName>", protocol, new List<IElementConnection> { mySnmpV1Connection });
83+
84+
DmsElementId id = agent.CreateElement(configuration);
85+
```
86+
87+
### Creating an SNMPv2c element
88+
89+
```csharp
90+
IDms dms = protocol.GetDms();
91+
IDma agent = dms.GetAgent(1000); // Obtain Agent where the element should be created.
92+
IDmsProtocol protocol = dms.GetProtocol("<ProtocolName>", "1.0.0.1"); // Specify the protocol
93+
IUdp port = new Udp("127.0.0.1", 161);
94+
95+
ISnmpV2Connection mySnmpV2Connection = new SnmpV2Connection(port);
96+
97+
ElementConfiguration configuration = new ElementConfiguration(dms, "<ElementName>", protocol, new List<IElementConnection> { mySnmpV2Connection });
98+
99+
DmsElementId id = agent.CreateElement(configuration);
100+
```
101+
102+
### Creating an SNMPv3 element
103+
104+
```csharp
105+
IDms dms = protocol.GetDms();
106+
IDma agent = dms.GetAgent(1000); // Obtain Agent where the element should be created.
107+
IDmsProtocol protocol = dms.GetProtocol("<ProtocolName>", "1.0.0.1");
108+
IUdp port = new Udp("127.0.0.1", 161);
109+
110+
SnmpV3SecurityConfig secConfig = new SnmpV3SecurityConfig("myUserName", "myAuthKey", SnmpV3AuthenticationAlgorithm.Md5, "myEncryptionKey", SnmpV3EncryptionAlgorithm.Aes128);
111+
ISnmpV3Connection mySnmpV3Connection = new SnmpV3Connection(port, secConfig);
112+
113+
ElementConfiguration configuration = new ElementConfiguration(dms, randomizedElementName, protocol, new List<IElementConnection> { mySnmpV3Connection });
114+
115+
DmsElementId id = agent.CreateElement(configuration);
116+
```
117+
118+
### Creating an HTTP element
119+
120+
The following example illustrates how to create an element with an HTTP connection:
121+
122+
```csharp
123+
private static void CreateElement(SLProtocol protocol)
124+
{
125+
IDms dms = protocol.GetDms();
126+
IDma agent = dms.GetAgent(protocol.DataMinerID);
127+
128+
IDmsProtocol elementProtocol = dms.GetProtocol("<ProtocolName>", "1.0.0.1");
129+
130+
ITcp port = new Tcp("127.0.0.1", 8888);
131+
IHttpConnection myHttpConnection = new HttpConnection(port);
132+
133+
var configuration = new ElementConfiguration(
134+
dms,
135+
"<ElementName>",
136+
elementProtocol,
137+
new List<IElementConnection> { myHttpConnection });
138+
139+
DmsElementId createdElementId = agent.CreateElement(configuration);
140+
}
141+
```

‎develop/toc.yml

+2
Original file line numberDiff line numberDiff line change
@@ -573,6 +573,8 @@
573573
topicUid: ClassLibraryIntroduction
574574
- name: Lazy loading
575575
topicUid: ClassLibraryLazyLoading
576+
- name: Element Creation
577+
topicUid: ClassLibraryElementCreation
576578
- name: InterApp classes
577579
topicUid: ClassLibraryInterAppClasses
578580
- name: Monitors

0 commit comments

Comments
 (0)