You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
@@ -99,7 +98,6 @@ The Agent Controller is started as a daemon of `systemd` and is coupled to it as
99
98
In pull mode, it listens on TCP port 6556 for incoming connections from the {CMK} xref:glossar#site[site] and queries the agent script via a Unix socket (of a `systemd` unit).
100
99
101
100
102
-
// start proofreading
103
101
[#slideout]
104
102
== Quick installation
105
103
@@ -111,12 +109,11 @@ The xref:intro_setup_monitor#linux[Beginner's Guide] describes the process in de
111
109
112
110
The main advantage of the slideout is that it displays directly in the GUI the appropriate commands for downloading, installing, and registering a Linux host.
113
111
You can copy any command to the clipboard and then run it on the host.
114
-
For a Linux host, the agent package is downloaded using curl via the REST API, installed with the `dpkg` or `rpm` commands, and the host is finally registered with `cmk-agent-ctl`.
112
+
For a Linux host, the agent package is downloaded using curl via the REST API, installed with the `dpkg` or `rpm` commands, and finally, the host is registered with `cmk-agent-ctl`.
115
113
endif::[]
116
114
117
-
118
115
ifdef::saas[]
119
-
{CMK} guides you through the user interface to download, install, and register the {CMK} agent on a host — and even add it to monitoring.
116
+
{CMK} guides you through the user interface to download, install, and register the {CMK} agent on a host -- and even add it to monitoring.
120
117
To do this, {CE} provides two assistants that guide you through the necessary steps in a _slideout_.
121
118
122
119
* One slideout helps you to automatically add a host to the xref:glossar#configuration_environment[configuration environment] and the xref:glossar#monitoring_environment[monitoring environment]. +
@@ -125,20 +122,18 @@ This uses the agent packages prepared for auto-registration for Linux and Window
125
122
* The other slideout guides you through the manual process of adding a host to the configuration environment.
126
123
Here, the standard packages available for Windows and Linux are used.
127
124
128
-
Both slideouts — one for xref:intro_setup_monitor#first_auto[automatic creation] and one for xref:intro_setup_monitor#first[manual creation] — are described in the Beginner's Guide.
125
+
Both slideouts -- one for xref:intro_setup_monitor#first_auto[automatic creation] and one for xref:intro_setup_monitor#first[manual creation] -- are described in the Beginner's Guide.
129
126
130
127
The main advantage of the slideouts is that they display directly in the GUI the appropriate commands for downloading, installing, and registering a Linux host.
131
128
You can copy any command to the clipboard and then run it on the host.
132
129
endif::[]
133
130
134
-
135
131
To make the process as simple as possible, authentication in the commands required for download and registration is performed using a _one-time token_.
136
132
This token is valid for successful execution within a limited time period.
137
-
It is generated first before being used in the aforementioned commands.
133
+
The token is first generated before being used in the aforementioned commands.
138
134
139
135
Quick download, installation, and registration via slideout are particularly well-suited for quickly creating the first hosts in {CMK}.
140
136
Detailed information on all possible methods for installing a standard agent (for example, without a one-time token, using xref:glossar#agent_plugin[agent plug-ins], and with troubleshooting) is provided in the following chapters.
141
-
// end proofreading
142
137
143
138
144
139
[#install]
@@ -182,14 +177,12 @@ Whether you need RPM or DEB depends on the Linux distribution on which you want
182
177
183
178
Before installation you will need to get the package and bring it to the host (for example with `scp` or WinSCP) where you want the agent to run.
184
179
185
-
// start proofreading
186
180
[IMPORTANT]
187
181
====
188
182
As of March 31, 2026, the agent packages provided by {CMK} do not yet include an Agent Controller for `aarch64` (ARM with a 64-bit instruction set).
189
183
Use the xref:glossar#agent_bakery[Agent Bakery] to create custom packages that include the Agent Controller for `aarch64` or both architectures.
190
184
You can specify the included architecture of the Agent Controller via the rule [.guihint]#Setup > Agents > Windows, Linux, Solaris, AIX > Agent rules > Customize agent package (Linux)#.
191
185
====
192
-
// end proofreading
193
186
194
187
195
188
[#download_gui]
@@ -624,18 +617,16 @@ Confirm with `Y` to complete the process.
624
617
If no error message is displayed, the encrypted connection will have been established.
625
618
All data will now be transmitted in compressed form via this connection.
626
619
627
-
If you want to disable the interactive check of the certificate--for example to fully automate the registration--you might use the additional parameter `--trust-cert`.
620
+
If you want to disable the interactive check of the certificate -- for example to fully automate the registration -- you might use the additional parameter `--trust-cert`.
628
621
The transferred certificate will be automatically trusted in this case.
629
622
Keep in mind that you should take other measures to verify the integrity of the certificate.
630
623
This can be performed (manually or scripted) by inspecting the xref:files[file] `/var/lib/cmk-agent/registered_connections.json`.
631
624
632
-
// start proofreading
633
625
[TIP]
634
626
====
635
627
Using the `cmk-agent-ctl` command, you can register the Agent Controller and the xref:glossar#agent_updater[Agent Updater] _at the same time_.
636
628
You can learn how this works in the article on xref:agent_deployment#one_registration[automatic agent updates].
637
629
====
638
-
// end proofreading
639
630
640
631
641
632
[#autoregister]
@@ -913,87 +904,11 @@ So that you can work with `less` here, you must combine standard output (STDOUT)
913
904
[#networkrequirements]
914
905
=== Network environment for registration
915
906
916
-
If registering a host fails even before a certificate is presented, knowledge about the ways of communication can help identifying the problem -- and of course solving it.
917
-
918
-
// This block is outdated
919
-
// delete from here
920
-
After entering the `cmk-agent-ctl register` command, the Agent Controller first asks the {CMK} server for the Agent Receiver port using the REST API.
921
-
As second step a connection to the Agent Receiver is established to request the certificate.
922
-
You can simulate the first request on the host with a program like `curl`:
907
+
If registering a host fails even before a certificate is presented, knowledge about the connections used for communication can help in identifying the problem -- and of course in solving it.
mentioned above, you can now adjust routing or firewall settings so that the host to be registered can reach the {CMK} server on the Agent Receiver's port (8000 or 8001...)
989
-
// delete to here
990
-
991
-
// This block is new
992
-
// start translation
993
-
////
994
-
Um herauszufinden, warum die Registrierung nicht erfolgreich war, führen Sie die Registrierung noch einmal mit der zusätzlichen Option `-vv` durch.
995
-
Dadurch werden Ihnen nicht nur Fehler, sondern auch zusätzliche Informationen und Debug-Meldungen ausgegeben.
996
-
Ist beispielsweise der {CMK}-Server vom Host aus nicht erreichbar, wird die Ausgabe etwa folgendermaßen aussehen:
909
+
To find out why the registration failed, run the registration again with the additional option `-vv`.
910
+
This will display not only errors but also additional information and debugging messages.
911
+
For example, if the {CMK} server is not accessible from the host, the output will look something like this:
ERROR [cmk_agent_ctl] Failed to discover agent receiver port from Checkmk REST API, both with http and https. Run with verbose output to see errors.
1014
929
----
1015
930
1016
-
Nach Absetzen des Befehls `cmk-agent-ctl register` fragt der Agent Controller zunächst über die REST-API den {CMK}-Server nach dem Port des Agent Receivers.
1017
-
In der oben gezeigten Ausgabe ist zu erkennen, dass die Verbindung über die REST-API fehlgeschlagen ist, und zwar sowohl über HTTPS als auch über HTTP.
1018
-
Logischerweise kann es an dieser Stelle mit der Registrierung nicht weitergehen.
931
+
After executing the `cmk-agent-ctl register` command, the Agent Controller first queries the {CMK} server via the RESTAPI to determine the port used by the Agent Receiver.
932
+
The output shown above indicates that the connection via the RESTAPI failed, both over HTTPS and HTTP.
933
+
Consequently, the registration process cannot proceed at this point.
1019
934
1020
-
An diesem Punkt können Sie die Routing- oder Firewall-Einstellungen so verändern, dass der Zugriff vom Host auf den {CMK}-Server möglich ist.
1021
-
Wenn der zu registrierende Host einen HTTP-Proxy verwendet, weisen Sie `cmk-agent-ctl` mit der zusätzlichen Option `--detect-proxy` an, den systemweit konfigurierten Proxy zu nutzen.
935
+
In such a situation you can modify the routing or firewall settings to allow access from the host to the {CMK} server.
936
+
If the host to be registered uses an HTTP proxy, instruct `cmk-agent-ctl` to use the system-wide configured proxy with the additional option `--detect-proxy`.
1022
937
1023
-
Ist der {CMK}-Server erreichbar und die Registrierung schlägt dennoch fehl, dann liegt das Problem an einer anderen Stelle.
1024
-
Möglicherweise ist die REST-API nicht erreichbar oder antwortet nicht mit dem richtigen Port für den Agent Receiver.
938
+
If the {CMK} server is reachable and registration still fails, the problem lies elsewhere.
939
+
The RESTAPI may be unreachable or may not be responding on the correct port for the Agent Receiver.
1025
940
1026
941
ifdef::onprem[]
1027
-
Sie können auf dem {CMK}-Server als Instanzbenutzer prüfen, welchem Port der Agent Receiver zugeordnet ist:
942
+
As a site user you can check which port the Agent Receiver is assigned to on the {CMK} server:
1028
943
1029
944
[{shell-raw}]
1030
945
----
@@ -1035,18 +950,17 @@ AGENT_RECEIVER_PORT: 8000
1035
950
endif::[]
1036
951
1037
952
ifdef::saas[]
1038
-
In {CE} wird dem Agent Receiver normalerweise der Port 8000 zugewiesen.
953
+
In {CE}, port 8000 is normally assigned to the Agent Receiver.
1039
954
endif::[]
1040
-
Den korrekten Port können Sie bei der Registrierung zusammen mit dem {CMK}-Server explizit angeben (`--server mycmkserver:8000`), um sicherzustellen, dass der Agent Receiver erreicht wird.
1041
-
So wird die erste Anfrage via REST-API übersprungen, und die Kommunikation findet ohne Umwege direkt mit dem Agent Receiver statt.
955
+
You can explicitly specify the correct port during registration, along with the {CMK} server (`--server mycmkserver:8000`) to ensure that the Agent Receiver can be reached.
956
+
This skips the first request via the REST API, and communication takes place directly with the Agent Receiver without any detours.
1042
957
1043
-
Möglicherweise erhalten Sie trotz korrekter Port-Angabe die Fehlermeldung `Connection refused`.
1044
-
In diesem Fall können Sie wiederum die Routing- oder Firewall-Einstellungen so anpassen, dass der zu registrierende Host den {CMK}-Server auf dem benötigten Port (hier `8000`) erreichen kann.
1045
-
1046
-
////
1047
-
// end translation
958
+
You may receive the error message `Connection refused` even though the port was specified correctly.
959
+
In this case, you can configure the routing or firewall settings so that the host to be registered can reach the {CMK} server on the required port (here `8000`).
1048
960
961
+
ifdef::onprem[]
1049
962
In the case of a registration in push mode the following applies:
963
+
endif::[]
1050
964
If the registration has worked, the minute-by-minute transfer of the agent output will also be successful.
0 commit comments