Structure and configuration of settings.ini

= General =

The settings.ini is a configuration file in which the initialisation of the data is stored. It is used so that the agents that have connected to the server can retrieve and check the details of the ACMP Clients. The file contains all the relevant information about the server (the name, port and server ID) by default, as well as the information about the client port that can be used to push the jobs from the server to the clients.

6

7

The settings.ini is located in the shared folder of the ACMP Server (//C:\Program Files (x86)\Aagon\ACMP Server\Clients//). Open the settings.ini with a common text editor to view the file content.

8

9

[[Content of a settings.ini>>image:66_Settings.ini_Beispiel eines Servers_421.png]]

10

11

= Structure of a settings.ini =

12

13

The configuration file can contain either a single server entry or several server entries (see [[Use Case: Installing ACMP Gateway via MSI>>doc:ACMP.67.ACMP-Solutions.System.Gateway.Use Cases für das Gateway.Use Case\: ACMP Gateway über die MSI installieren.WebHome]]). This makes it possible to address several ACMP Servers directly within a single file, to create network mappings, to prepare server migrations or to create „multi-server clients“.

14

15

The information contained is always listed line by line, with an equal sign separating the key from its value:

Key=Value

SERVERPORT=2106

For a better overview, the keys are divided into groups called sections. To do this, the name of a file that is to be clearly defined must be enclosed in square brackets. The spelling of the key is not case-sensitive.

24

25

26

Selection counting always starts with the number 0 (zero) and is incremented for multiple entries.

Example:

[Section0]

Key=Value

Key2=Value

[Section1]

Key=Value

Key2=Value

Schlüssel3=Wert

Please note that each section and each key used may only occur once per section. If you wish to store comments in the file, these must be preceded by a semicolon and placed on a separate row. Example:

[SERVER|0]

SERVERNAME=server1.acmp.local

48

SERVERPORT=2106

49

; check the server name for information on whether the caption has changed

== Example of a settings.ini ==

54

55

The example below shows a sample file containing the configuration of two server entries, the mapping and the installation path of the Client. The column //Value// indicates what can be entered in a settings.ini. The column //Explanation //explains and justifies the respective content.

56

57

| |(% style="width:392px" %)**Value**|(% style="width:1261px" %)**Explanation**

58

| 1.|(% style="width:392px" %)[Servers]|(% style="width:1261px" %)Specifies the section, i.e. the [Servers]

59

| 2.|(% style="width:392px" %)max=1|(% style="width:1261px" %)Indicates the value (max) and the indication of the available Servers. The content is 1, where counting starts at 0.

60

| 3.|(% style="width:392px" %) |(% style="width:1261px" %)

61

| 4.|(% style="width:392px" %)[SERVER~|0]|(% style="width:1261px" %)Specifies the SERVER section and the first server; the count starts at 0 (zero). The syntax is therefore SERVER~|<N>

62

| 5.|(% style="width:392px" %)SERVERNAME=server1.acmp.local|(% style="width:1261px" %)The content is the key (SERVERNAME) and the value (server1.acmp.local) separated by an equal sign; here the server name or the IP of the ACMP Server to be used.

63

| 6.|(% style="width:392px" %)SERVERPORT=2106|(% style="width:1261px" %)The key (SERVERPORT) corresponds to the value of the ACMP server port to be used, in this example port 2106

64

| 7.|(% style="width:392px" %)ServerId={CA191843-xxxx-494C-9934-xxxxxxxxxxxx}|(% style="width:1261px" %)The key (ServerId) has been assigned the value of the server ID ({CA191843-xxxx-494C-9934-xxxxxxxxxxxx})

65

| 8.|(% style="width:392px" %)MaxBandWidth=100000|(% style="width:1261px" %)MaxBandWidth stands for the maximum bandwidth to be used (bits per second). If the specification is unlimited, a zero can also be entered (0=unlimited).

66

| 9.|(% style="width:392px" %) |(% style="width:1261px" %)

67

|10.|(% style="width:392px" %)[SERVER~|1]|(% style="width:1261px" %)Recurrence of row 4, only for the second listed Server ([SERVER~|1]))

68

|11.|(% style="width:392px" %)SERVERNAME=server2.acmp.local|(% style="width:1261px" %)Recurrence of row 5 (Server name or the IP of the ACMP Server)

69

|12.|(% style="width:392px" %)SERVERPORT=2106|(% style="width:1261px" %)Recurrence of row 6 (specification of server port)

70

|13.|(% style="width:392px" %)ServerId={FDS1843-xxxx-494C-9934-xxxxxxxxxxxx}|(% style="width:1261px" %)Recurrence of row 7 (specification of Server ID)

71

|14.|(% style="width:392px" %)MaxBandWidth=0|(% style="width:1261px" %)Recurrence of row 8 for maximum bandwidth in bits per second

72

|15.|(% style="width:392px" %) |(% style="width:1261px" %)

73

|16.|(% style="width:392px" %)[CLIENTPORT]|(% style="width:1261px" %)Specifies the section, in this case the [CLIENTPORT]. The port is used to push Jobs from the Server to the Clients.

74

|17.|(% style="width:392px" %)VALUE=2108|(% style="width:1261px" %)Indicates the value (VALUE) and the content of the ACMP client port used

75

|18.|(% style="width:392px" %) |(% style="width:1261px" %)

76

|19.|(% style="width:392px" %)[Mappings]|(% style="width:1261px" %)Introduces the [Mappings] section

77

|20.|(% style="width:392px" %)max=1|(% style="width:1261px" %)The value (max) indicates the number of available mappings, starting from 0 (zero).

78

|21.|(% style="width:392px" %) |(% style="width:1261px" %)

79

|22.|(% style="width:392px" %)[Mapping~|0]|(% style="width:1261px" %)Introduces the mappings section. The first mapping must start with the number 0 (zero) (Mapping~|<N>)

80

|23.|(% style="width:392px" %)NetworkAddress=192.168.0.0|(% style="width:1261px" %)The NetworkAddress key specifies the net address to which the mapping should apply. The value for this is written after the equals sign.

81

|24.|(% style="width:392px" %)NetworkMask=255.255.255.0|(% style="width:1261px" %)The NetworkMask key specifies the net mask to which the mapping should apply (here: 255.255.255.0)

82

83

|26.|(% style="width:392px" %) |(% style="width:1261px" %)

84

|27.|(% style="width:392px" %)[Mapping~|1]|(% style="width:1261px" %)Recurrence of row 22, where the second mapping is defined ([Mapping~|1])

85

|28.|(% style="width:392px" %)NetworkAddress=192.168.1.0|(% style="width:1261px" %)Recurrence of row 23 with the adapted net address for the mapping

86

|29.|(% style="width:392px" %)NetworkMask=255.255.255.0|(% style="width:1261px" %)Recurrence of row 24 with the net mask

87

88

|31.|(% style="width:392px" %) |(% style="width:1261px" %)

89

|32.|(% style="width:392px" %)[CLTDEFLOC]|(% style="width:1261px" %)The [CLTDEFLOC] section specifies the default storage location for the client.

90

|33.|(% style="width:392px" %)Value=0|(% style="width:1261px" %)The value determines where the installation path of the Clients should be:

91

0=C:\ACMPClient

92

1=1:\Program Files (x86)\ACMPClient

93

94

95

The bandwidth restriction (rows 8 and 14) is used if no client-specific restriction has been stored in the Client's registry. Any changes made on the ACMP Server will be applied without having to restart the Agent service.

96

97

98

[[Configured settings.ini>>image:66_Settings.ini_Beispiel einer größeren Datei_421.png]]

99

100

101

You can make manual changes to the settings.ini directly in the text editor of your choice by correcting the appropriate place and then saving the file.

102

103

104

== Procedure of the Clients ==

105

106

As soon as one or more mappings have been stored in a settings.ini, the specified servers are initially ignored. The client checks all the entered mappings and, for each individual mapping, checks whether the current IP address matches the information in the section. If the IP matches, the client enters the server that was stored under ‘PreferredServer’ in its server list. If no mapping matches, all servers are entered into the server list in sequence. If the client cannot reach the current server, it falls back to the next one on its list. For continuing server requests, the last accessible server is contacted first. When an agent is restarted, another attempt is made to reach the primary server.

107

108

109

If the entries under NetworkAddress or NetworkMask are missing or invalid, the values are treated as 0.0.0.0. This means that the Client is not located in an area that is covered. As a result, the Server is not entered in the Server list.

110

111

112

(% class="box infomessage" %)

113

(((

114

[[image:https://doc.aagon.com/bin/download/XWiki/Aagon Infobox/WebHome/Information.svg||alt="Hinweis" height="32" width="32"]] **Hinweis: **

115

116

If there are no servers in the server list after evaluating all mappings (e.g. because no suitable entries were found or no mappings are available), the previous behaviour of the client is applied, so that the client takes over all servers from the Client.ini into the server list.

)))

Wiki source code of Aufbau und Konfiguration der settings.ini

Navigation

author	version	line-number	content
		1	{{aagon.floatingbox/}}
		2
		3	= General =
		4
		5	The settings.ini is a configuration file in which the initialisation of the data is stored. It is used so that the agents that have connected to the server can retrieve and check the details of the ACMP Clients. The file contains all the relevant information about the server (the name, port and server ID) by default, as well as the information about the client port that can be used to push the jobs from the server to the clients.
		6
		7	The settings.ini is located in the shared folder of the ACMP Server (//C:\Program Files (x86)\Aagon\ACMP Server\Clients//). Open the settings.ini with a common text editor to view the file content.
		8
		9	[[Content of a settings.ini>>image:66_Settings.ini_Beispiel eines Servers_421.png]]
		10
		11	= Structure of a settings.ini =
		12
		13	The configuration file can contain either a single server entry or several server entries (see [[Use Case: Installing ACMP Gateway via MSI>>doc:ACMP.67.ACMP-Solutions.System.Gateway.Use Cases für das Gateway.Use Case\: ACMP Gateway über die MSI installieren.WebHome]]). This makes it possible to address several ACMP Servers directly within a single file, to create network mappings, to prepare server migrations or to create „multi-server clients“.
		14
		15	The information contained is always listed line by line, with an equal sign separating the key from its value:
		16
		17	{{code language="none"}}
		18	Key=Value
		19	SERVERPORT=2106
		20
		21	{{/code}}
		22
		23	For a better overview, the keys are divided into groups called sections. To do this, the name of a file that is to be clearly defined must be enclosed in square brackets. The spelling of the key is not case-sensitive.
		24
		25	{{aagon.infobox}}
		26	Selection counting always starts with the number 0 (zero) and is incremented for multiple entries.
		27	{{/aagon.infobox}}
		28
		29	Example:
		30
		31
		32	{{code language="none"}}
		33	[Section0]
		34	Key=Value
		35	Key2=Value
		36
		37	[Section1]
		38	Key=Value
		39	Key2=Value
		40	Schlüssel3=Wert
		41	{{/code}}
		42
		43	Please note that each section and each key used may only occur once per section. If you wish to store comments in the file, these must be preceded by a semicolon and placed on a separate row. Example:
		44
		45	{{code language="none"}}
		46	[SERVER\|0]
		47	SERVERNAME=server1.acmp.local
		48	SERVERPORT=2106
		49	; check the server name for information on whether the caption has changed
		50
		51	{{/code}}
		52
		53	== Example of a settings.ini ==
		54
		55	The example below shows a sample file containing the configuration of two server entries, the mapping and the installation path of the Client. The column //Value// indicates what can be entered in a settings.ini. The column //Explanation //explains and justifies the respective content.
		56
		57	\| \|(% style="width:392px" %)Value\|(% style="width:1261px" %)Explanation
		58	\| 1.\|(% style="width:392px" %)[Servers]\|(% style="width:1261px" %)Specifies the section, i.e. the [Servers]
		59	\| 2.\|(% style="width:392px" %)max=1\|(% style="width:1261px" %)Indicates the value (max) and the indication of the available Servers. The content is 1, where counting starts at 0.
		60	\| 3.\|(% style="width:392px" %) \|(% style="width:1261px" %)
		61	\| 4.\|(% style="width:392px" %)[SERVER~\|0]\|(% style="width:1261px" %)Specifies the SERVER section and the first server; the count starts at 0 (zero). The syntax is therefore SERVER~\|<N>
		62	\| 5.\|(% style="width:392px" %)SERVERNAME=server1.acmp.local\|(% style="width:1261px" %)The content is the key (SERVERNAME) and the value (server1.acmp.local) separated by an equal sign; here the server name or the IP of the ACMP Server to be used.
		63	\| 6.\|(% style="width:392px" %)SERVERPORT=2106\|(% style="width:1261px" %)The key (SERVERPORT) corresponds to the value of the ACMP server port to be used, in this example port 2106
		64	\| 7.\|(% style="width:392px" %)ServerId={CA191843-xxxx-494C-9934-xxxxxxxxxxxx}\|(% style="width:1261px" %)The key (ServerId) has been assigned the value of the server ID ({CA191843-xxxx-494C-9934-xxxxxxxxxxxx})
		65	\| 8.\|(% style="width:392px" %)MaxBandWidth=100000\|(% style="width:1261px" %)MaxBandWidth stands for the maximum bandwidth to be used (bits per second). If the specification is unlimited, a zero can also be entered (0=unlimited).
		66	\| 9.\|(% style="width:392px" %) \|(% style="width:1261px" %)
		67	\|10.\|(% style="width:392px" %)[SERVER~\|1]\|(% style="width:1261px" %)Recurrence of row 4, only for the second listed Server ([SERVER~\|1]))
		68	\|11.\|(% style="width:392px" %)SERVERNAME=server2.acmp.local\|(% style="width:1261px" %)Recurrence of row 5 (Server name or the IP of the ACMP Server)
		69	\|12.\|(% style="width:392px" %)SERVERPORT=2106\|(% style="width:1261px" %)Recurrence of row 6 (specification of server port)
		70	\|13.\|(% style="width:392px" %)ServerId={FDS1843-xxxx-494C-9934-xxxxxxxxxxxx}\|(% style="width:1261px" %)Recurrence of row 7 (specification of Server ID)
		71	\|14.\|(% style="width:392px" %)MaxBandWidth=0\|(% style="width:1261px" %)Recurrence of row 8 for maximum bandwidth in bits per second
		72	\|15.\|(% style="width:392px" %) \|(% style="width:1261px" %)
		73	\|16.\|(% style="width:392px" %)[CLIENTPORT]\|(% style="width:1261px" %)Specifies the section, in this case the [CLIENTPORT]. The port is used to push Jobs from the Server to the Clients.
		74	\|17.\|(% style="width:392px" %)VALUE=2108\|(% style="width:1261px" %)Indicates the value (VALUE) and the content of the ACMP client port used
		75	\|18.\|(% style="width:392px" %) \|(% style="width:1261px" %)
		76	\|19.\|(% style="width:392px" %)[Mappings]\|(% style="width:1261px" %)Introduces the [Mappings] section
		77	\|20.\|(% style="width:392px" %)max=1\|(% style="width:1261px" %)The value (max) indicates the number of available mappings, starting from 0 (zero).
		78	\|21.\|(% style="width:392px" %) \|(% style="width:1261px" %)
		79	\|22.\|(% style="width:392px" %)[Mapping~\|0]\|(% style="width:1261px" %)Introduces the mappings section. The first mapping must start with the number 0 (zero) (Mapping~\|<N>)
		80	\|23.\|(% style="width:392px" %)NetworkAddress=192.168.0.0\|(% style="width:1261px" %)The NetworkAddress key specifies the net address to which the mapping should apply. The value for this is written after the equals sign.
		81	\|24.\|(% style="width:392px" %)NetworkMask=255.255.255.0\|(% style="width:1261px" %)The NetworkMask key specifies the net mask to which the mapping should apply (here: 255.255.255.0)
		82	\|25.\|(% style="width:392px" %)PreferredServer=Server~\|0\|(% style="width:1261px" %)Specifies the server to be used (Server~\|0), which was previously named in row 4.
		83	\|26.\|(% style="width:392px" %) \|(% style="width:1261px" %)
		84	\|27.\|(% style="width:392px" %)[Mapping~\|1]\|(% style="width:1261px" %)Recurrence of row 22, where the second mapping is defined ([Mapping~\|1])
		85	\|28.\|(% style="width:392px" %)NetworkAddress=192.168.1.0\|(% style="width:1261px" %)Recurrence of row 23 with the adapted net address for the mapping
		86	\|29.\|(% style="width:392px" %)NetworkMask=255.255.255.0\|(% style="width:1261px" %)Recurrence of row 24 with the net mask
		87	\|30.\|(% style="width:392px" %)PreferredServer=Server~\|1\|(% style="width:1261px" %)Recurrence of row 25 with the specification of the server to be used (Server~\|1), which was named in row 10
		88	\|31.\|(% style="width:392px" %) \|(% style="width:1261px" %)
		89	\|32.\|(% style="width:392px" %)[CLTDEFLOC]\|(% style="width:1261px" %)The [CLTDEFLOC] section specifies the default storage location for the client.
		90	\|33.\|(% style="width:392px" %)Value=0\|(% style="width:1261px" %)The value determines where the installation path of the Clients should be:
		91	0=C:\ACMPClient
		92	1=1:\Program Files (x86)\ACMPClient
		93
		94	{{aagon.infobox}}
		95	The bandwidth restriction (rows 8 and 14) is used if no client-specific restriction has been stored in the Client's registry. Any changes made on the ACMP Server will be applied without having to restart the Agent service.
		96	{{/aagon.infobox}}
		97
		98	[[Configured settings.ini>>image:66_Settings.ini_Beispiel einer größeren Datei_421.png]]
		99
		100	{{aagon.infobox}}
		101	You can make manual changes to the settings.ini directly in the text editor of your choice by correcting the appropriate place and then saving the file.
		102	{{/aagon.infobox}}
		103
		104	== Procedure of the Clients ==
		105
		106	As soon as one or more mappings have been stored in a settings.ini, the specified servers are initially ignored. The client checks all the entered mappings and, for each individual mapping, checks whether the current IP address matches the information in the section. If the IP matches, the client enters the server that was stored under ‘PreferredServer’ in its server list. If no mapping matches, all servers are entered into the server list in sequence. If the client cannot reach the current server, it falls back to the next one on its list. For continuing server requests, the last accessible server is contacted first. When an agent is restarted, another attempt is made to reach the primary server.
		107
		108	{{aagon.infobox}}
		109	If the entries under NetworkAddress or NetworkMask are missing or invalid, the values are treated as 0.0.0.0. This means that the Client is not located in an area that is covered. As a result, the Server is not entered in the Server list.
		110	{{/aagon.infobox}}
		111
		112	(% class="box infomessage" %)
		113	(((
		114	[[image:https://doc.aagon.com/bin/download/XWiki/Aagon Infobox/WebHome/Information.svg\|\|alt="Hinweis" height="32" width="32"]] Hinweis:
		115
		116	If there are no servers in the server list after evaluating all mappings (e.g. because no suitable entries were found or no mappings are available), the previous behaviour of the client is applied, so that the client takes over all servers from the Client.ini into the server list.
		117	)))
		118
		119
		120