Wiki source code of Unix Agent installieren

Last modified by Sabrina V. on 2025/11/20 07:20

Show last authors
1 {{aagon.floatingbox/}}
2
3 (% class="wikigeneratedid" %)
4 The Unix Agent is the completely renewed and technically revised further development of the Linux and Mac agents. The agent can be deployed and installed without Python using a supplied Client Command. The inventory data is transmitted to the ACMP Server in full and updated.
5
6 {{aagon.infobox}}
7 If you use Unix clients that are not connected to the network, you can inventory them using the [[Unix Offline Scanner>>doc:ACMP.69.Arbeiten mit der ACMP Console.Clients erfassen.Offline Scanner.WebHome||anchor="“HRunUnixOfflineScanner”"]].
8 {{/aagon.infobox}}
9
10 = Installation requirements =
11
12 There are several requirements for you and your system for installing the Unix Agent.
13
14 === Requirements for your knowledge of ACMP ===
15
16 * You have a basic understanding of how to configure SICS.
17 * You know how to import Client Commands into ACMP.
18 * You know how to execute Client Commands.
19
20 === Requirements for your environment ===
21
22 * ACMP is installed.
23 * SICS is installed on a server.
24 * The ACMP Server is connected to SICS.
25 * SICS users are allowed to access the public API.
26
27 === Requirements for your MacOS and Linux systems ===
28
29 Our [[general system requirements>>https://www.aagon.com/produkte/ueberblick/systemanforderungen-acmp/#c4421]] provide an overview of all tested distributions.
30
31 In addition, certain settings are required on your systems:
32
33 * An installed SSH server that is accessible from outside (important for agent distribution).
34 * Root must be able to log in from outside via ssh or, alternatively, a user who can obtain root rights via sudo (sudo must be installed for the alternative).
35 * Linux and MacOS Clients must be able to reach SICS via Rest (any firewalls must allow port 3950).
36 * Firewall settings for SICS must be customizable if necessary.
37
38 = Installation with the Client Command =
39
40 An existing SICS connection to the ACMP server is required to install the Unix Agent. If you have not yet configured a SICS connection, you must do so first. Instructions for configuring the SICS connection can be found in the section [[Configuring the SICS connection>>doc:AESB.19.AESB installieren, konfigurieren und aktualisieren.SICS-Verbindung konfigurieren.WebHome]].
41
42 The Unix Agent is installed using a Client Command in ACMP. To do this, the Client Command must first be imported and released.
43
44 {{aagon.warnungsbox}}
45 Installing the Unix Agent stops and removes the Linux Agent.
46
47 The ClientID used by the Linux Agent is retained and reused by the Unix Agent.
48 {{/aagon.warnungsbox}}
49
50 === Import and release Client Command ===
51
52 The file for the required Client Command of the Unix Agent is named as in the following example:
53
54 {{{ACMP Unix Agent verteilen & Inventory__{1F5A4238-731B-44B6-84F0-3EFB8F2D3222}.sim}}}
55
56 For information on how to import and release a Client Command in ACMP, refer to the section [[Create Client Commands>>doc:ACMP.67.ACMP-Solutions.Client Commands.Client Command erstellen.WebHome||anchor="HImport"]] .
57
58 === Execute Client Command ===
59
60 After you have released the Client Command, you can execute it.
61
62 In the ACMP Console, navigate to Client Commands > Execute. Then double-click to select the Client Command for the Unix Agent.
63
64 In the dialog window that opens, click the //Execute// button. The Client Command interface opens, where you can configure the installation of the Unix Agent.
65
66 [[Configuring the Unix Agent using the Client Command>>image:Unix Agent - Fallback-SICS.png||alt="“Configuring" data-xwiki-image-style-alignment="center" height="600" width="480"]]
67
68 = Configuring the Unix Agent =
69
70 For the configuration of the Unix Agent, there are various areas in the Client Command where you can make specific settings.
71
72 === SSH credentials ===
73
74 The Unix Agent is transferred to the target computers via SSH; valid user data must be entered accordingly. Unlike the Linux Agent, the Unix Agent transfers the scan data directly to the ACMP Server.
75
76 {{aagon.warnungsbox}}
77 The user whose user data is specified as SSH credentials for the installation must be created on each of the target computers and have “sudo” rights (superuser do) there.
78 {{/aagon.warnungsbox}}
79
80 === Select Clients ===
81
82 In the upper right corner of the dialog window, you can use the IPv4 address to specify the clients on which the Unix Agent is to be deployed. To do this, you can either specify an IPv4 range or compile a list of IPv4 addresses.
83
84 === Specify SICS credentials ===
85
86 To install the Unix Agent on the target computers, you must specify your SICS session data. The specified endpoint must be in the format //wss:~/~/ipaddress:port//. Please note that all target computers must have access to this endpoint. You assigned the continuing user data to the operator during the AESB installation.
87
88 You can also specify multiple fallback SICS connections in the tabs. If the primary SICS connection fails and cannot be used, an attempt is made to establish a connection to another defined SICS and to carry out the transfer via one of the fallback connections. The list of fallback SICS connections is used continuously, starting with fallback SICS #1, until a connection to one of the defined fallback SICS connections can be established or there are no more fallback connections in the list.
89
90 {{aagon.infobox}}
91 If the connection to one of the defined fallback SICS could be established successfully, the connection is maintained until the next restart.
92 {{/aagon.infobox}}
93
94 === Options ===
95
96 In the //Options //area, you can configure settings for logging and specify the mode in which the agent should be executed.
97
98 **Enable logging**
99
100 By selecting the //Enable logging// option, you can load the logs to your machine (or the machine with the ACMP Console) after installation or execution. Enabling logging is already available at this point in the Client Command and can be useful, as errors may occur during installation or execution as Inventory One-Time-Scan.
101
102 **One-time scan**
103
104 For a one-time inventory of a client, the agent can be executed in //One-time scan// mode. The Unix agent is now transferred to the target computer and started. After the scanner has been executed successfully, the agent is removed from the system again. To ensure that the new results can be assigned accordingly when the //One-time scan// mode is executed again, the ClientID remains on the client. You can find this under the path: ##/etc/aagon/ACMPUnixAgent/agentId##
105
106 **Agent installation**
107
108 To install the Unix Agent as a permanent resource, you can execute the agent in the //Agent Installation// mode. The Unix Agent is now transferred to the target computer and registered as a service. Following installation, the agent starts automatically and obtains its configuration from ACMP within 10 minutes. The agent is now entered as a client in ACMP and contains the basic client details. The execution file can be found under the path: ##/usr/local/sbin/aagon/ACMPUnixAgent/##
109
110 The agent also uses another directory to store various resources that are relevant to the agent. This directory can be found under the path:## /etc/aagon/ACMPUnixAgent/##
111
112 The Agent Tasks templates are used to execute the scanners. These can be used in exactly the same way as with the ACMP Windows Agent (Container). The following jobs are currently taken into account within the Agent Tasks:
113
114 * System scanner
115 * Software scanner
116 * Update settings
117
118 **Uninstall agent**
119
120 To uninstall the Unix agent as a service, you can execute the agent in the //Uninstall agent// mode. The registered Unix agent service is now removed from the target computer together with the execution file.
121
122 === Activated scanners ===
123
124 In the //Activated Scanners// area, you can disable individual scanners. This is useful if you do not need certain information or if problems occur with one or more scanners.
125
126 === Client Command Settings ===
127
128 By clicking the checkbox in the CC Settings area, you can specify that no confidential information (e.g., passwords) is stored in the Client Command.
129
130 === Feedback on execution ===
131
132 After executing the Client Command, a dialog window will appear informing you whether the Client Command was executed successfully. The number of processed Clients is displayed, along with information on whether connection errors (SSH errors) were detected.
133
134 {{figure}}
135 [[image:CC_Erfolgsmeldung.png||alt="“Success" data-xwiki-image-style-alignment="“center”"]]
136
137 {{figureCaption}}
138 Success message about installation of the Unix Agent
139 {{/figureCaption}}
140 {{/figure}}
141
142 = Logging =
143
144 If connection errors occur during the execution of the Unix Agent, these errors are written to the file ##SSH_Errors.log## and to the log of the Client Command. You can find the file either in the default folder ##C:\Logs## or in the directory you specified for logging the Unix Agent.
145
146 {{aagon.infobox}}
147 These connection errors do not cause the Client Command to be terminated. Therefore, these errors are not displayed if you have selected the logging setting //Only on errors //for the console log.
148 {{/aagon.infobox}}
149
150 If you would like to receive immediate feedback about possible connection errors after executing the Client Command, you should either select the //Always //option for the console log settings or check the file ##SSH_Errors.log##.
151
152 = Troubleshooting =
153
154 Below you will find solutions to various problems that may occur during the installation of the Unix Agent.
155
156 ----
157
158 **Symptom:** The Unix Agent could not be deployed on the Clients and no errors are displayed in the log.
159
160 **Cause: **The Unix Agent does not yet exist as a service, so no errors can be written to the log.
161
162 **Action: **Start troubleshooting in your system's journalctl and find entries for the failed installation of the Unix Agent.
163
164 ----
165
166 **Symptom:** After distributing the Unix Agent using the Client Command, the Unix client does not appear in ACMP.
167
168 **Cause:** An error occurred during the execution of the Client Command, but was not immediately apparent due to the settings.
169
170 **Action:** In the properties of the Client Command in the plugin //Options //in the Combobox //Show console log// enable the option //Only on errors// and confirm the
171 dialog with //OK//. After executing the Client Command again, a console log should now be displayed in the event of an error, which may provide information about the cause of the problem.
172
173 If the Unix systems still do not appear in ACMP, there may be many reasons for this. It is therefore recommended to activate logging for the agent and the SICS. Then go through the chain from start to end.
174
175 ----
176
177 **Symptom:** After distributing the Unix Agent using the Client Command, the Unix client does not appear in ACMP. The error “Invalid input detected: endpoint” is displayed in the SmartInspect log.
178
179 **Cause:** An error occurred during the connection to SICS because the protocol may not have been prefixed during the connection. You can see this in the SmartInspect log in the row //Application settings//: ##“SicsEndpoint: <AESB-SICS-NAME_IP>:3950”##
180
181 **Action:** Make sure that the SICS endpoint is set to ##wss:~/~/<AESB-SICS-NAME_IP>:3950## and not just ##<AESB-SICS-NAME_IP>:3950##
182
183 ----
184
185 **Symptom:** The Unix Agent is not located on the target system at the following location: ##/usr/local/sbin/aagon/ACMPUnixAgent.##
186
187 **Cause:** There may be several causes for this problem:
188
189 * The login user is not allowed to obtain root rights via sudo.
190 * The user has root rights, but root is not allowed to log in via SSH.
191 * The user has root rights and root is not allowed to log in via SSH, but the SSH daemon is not running properly.
192
193 **Action:** Make sure that the SSH user is allowed to log in via SSH and can obtain root rights.
194
195 ----
196
197 **Symptom:** The Unix agent starts but does not reach the //running// status.
198
199 **Cause:** The agent does not seem to be able to connect to SICS.
200
201 **Action:** Check whether the network connection to SICS is working. If this does not solve the problem, enable logging in the Client Command and perform the action again. Then look for error messages in the output.
202
203 ----
204
205 **Symptom:** The agent is not started at system start.
206
207 **Cause:** Something went wrong when setting up or starting the service.
208
209 **Action:** Execute the Client Command for installing the Unix Agent again.
210
211 ----
212
213 **Symptom:** The Unix Agent is running, but the corresponding Unix client does not appear in an ACMP query.
214
215 **Cause:** The SICS cannot forward the scan data of the Unix Agent to the ACMP Server because the connection is not available.
216
217 **Action:** Check in the ACMP Console settings whether the SICS connection of the ACMP Server is still working (in the ACMP Server / SICS connection plugin) and whether the checkbox for SICS users to access the public API is activated. Further information on this problem can be found in the log of the ACMP Server or the Unix Agent.
218
219 ----
220
221 **Symptom:** The Unix client appears in an ACMP query, but no scan data is available.
222
223 **Cause:** During installation, the system waits between 2 and 10 minutes until the scan settings for this Unix client are retrieved by sending a request to the ACMP Server.
224
225 **Action: **If necessary, wait a little longer until the scan data has been loaded. If no scan data appears after significantly more than 10 minutes, you should enable logging for all components involved and check the entire chain from start to end for errors.
226
227 = Administration of Linux and MacOS Clients =
228
229 Previously, clients running Linux or macOS could only be detected and inventoried with the Unix Agent. They could not, however, be administered, and no shell scripts or jobs could be executed on these clients. Now, newly detected Linux and macOS clients can be managed if inventoried using the Unix Agent. This also enables the automated, time-controlled execution of Unix scripts as jobs. For more info, see the section [[Unix Scripts>>doc:ACMP.68.ACMP-Solutions.Desktop Automation.Unix Scripts.WebHome]].
230
231 (% class="box infomessage" %)
232 (((
233 [[image:https://doc.aagon.com/bin/download/XWiki/Aagon Infobox/WebHome/Information.svg||alt="Hinweis" height="32" width="32"]] **Note: **
234
235 All Linux and MacOS clients that are registered with Unix Agent version 1.10 or older cannot be managed. To make your Linux or MacOS clients manageable, register them again via the Unix Agent.
236 )))
© Aagon GmbH 2025
Besuchen Sie unsere Aagon-Community