opsiconfd Service

On the Info tab, you can view general information about opsiconfd. This includes the number of connected depot servers and clients, as well as details about the opsi-CA and the server certificate.

In the lower section of this tab, the opsiconfd configuration is displayed. You have the option to reload this configuration using the Service reload button.

On the Maintenance tab, you can put opsiconfd into maintenance mode and later end it. During maintenance mode, client activities are paused. To activate maintenance mode, click on Set application to 'maintenance' state. Once activated, you will see the message "accomplished": true displayed at the top, along with IP addresses that are exempt from maintenance mode. Typically, these are the localhost IP 127.0.0.1 and the IP address of the opsi config server. Access from other computers is blocked during this time, and users attempting to connect will see a message stating Maintenance mode, please try again later.

To deactivate maintenance mode and resume normal operation, click on Set application to 'normal' state.

On this tab, you manage the setup of two-factor authentication (2FA) for users on the opsi config server. Once you have appropriately configured opsiconfd and restarted the service, you can initiate 2FA by clicking the Generate new secret and activate TOTP button. This action generates a one-time password comprised of six digits, which will be required in addition to the usual login credentials for accessing the opsi server. More details about this process are available in the section Two-Factor Authentication.

The tab displays information about connected clients and their sessions. Clients that have been blocked are listed under Blocked clients. To unblock an individual client, use the Unblock clients section by entering their IP address and clicking Execute. Alternatively, you can unblock all clients at once using the Unblock all clients button.

To delete all sessions associated with a specific client, enter its IP address in the Delete client sessions field and click Execute to confirm.

In the upper section of this tab, you have the option to add additional depot servers to your opsi environment. Start by entering the depot ID (which is the FQDN of the opsi depot server) and a brief description in the provided fields. After clicking on Create depot, the new depot should appear in the table. Initially, the Messagebus column will display not connected. To establish communication between the config server and the new depot server, you need to execute the following command on the depot server:

If there are locked products on a depot server, they will also appear in the Locked Products section of this tab. You can unlock a specific product by clicking the Unlock button next to it. To remove the lock on all products, use the Unlock all button.

The table displayed on this tab chronicles the most recent RPC (Remote Procedure Call) activities. You can organize the data by clicking on the headers of the table columns to sort the information accordingly.

This tab provides a comprehensive list of all methods available in the JSON-RPC API. By selecting the Show deprecated methods checkbox, you can also view methods that are deprecated. To explore a specific method, choose one from the Method drop-down menu. Depending on the selected method, you may see additional input fields for attributes, filters, or parameters. These fields require valid JSON encoding, and any syntax errors will be highlighted by the interface.

When you click the Execute button, the selected method will be executed. The request, processing time, and result will then be displayed below in JSON format.

On this tab, you can view Redis status information, execute Redis commands, and clear the cache. By clicking on Info+, you can access detailed information about the Redis version, operating system, server architecture, and more.

The responses to any actions or queries you perform on this tab will be displayed at the bottom in JSON format.

On the Addons tab, you manage the installation of opsiconfd extensions. Initially, download these extensions from our opsi Tools Website and save them onto the opsi server. To install an addon, click Browse on the Addons tab, then in the file selection dialog, navigate to the zip file, select it, and finally click on Install addon.

The table on this tab not only shows the name and ID of each installed extension but also displays their version number and the installation path on the server.

The tab offers quick access to the opsiconfd logfiles (refer to section Logfiles). Enhance your viewing area with the Maximize button, and apply filters to the logs based on log level (Filter by level), context (Filter by context), or specific search terms (Filter by message). Use checkboxes for additional functionalities like condensing multi-line entries into single lines (Collapse multi-line) and enabling automatic updates to the display (Auto scroll). Adjust the font size for ease of reading using the buttons next to Font size.

Navigate to this tab to launch a terminal window on the opsi server. Start by selecting an opsi server from your environment using the Host drop-down menu (the default is set to Configserver). Then, click on Connect. This action will open the terminal within the browser, where you will be logged in as the user opsiconfd and positioned in its home directory, /var/lib/opsi.

To expand the terminal window, click the Maximize button, which hides the top menu of the admin page for more space. To revert to the original view, select Normalize. For an even larger display, choose Fullscreen, which can be exited by pressing [Esc]. The font size within the terminal can be adjusted using the plus and minus buttons next to Font size, and you can close the terminal in the browser by clicking on Disconnect.

On this tab, you can send and receive messages via the message bus, primarily for testing and debugging purposes. The opsi server uses the message bus to communicate with other components, such as sending installation jobs, configuration changes, or status queries to clients.

To use this feature, choose a template from the drop-down menu next to the Send button and input the appropriate values in the upper field. After filling out the template, click on Send. In the lower section of the tab, you will see the message you sent on the left and the response from the opsi message bus on the right.

On the Licensing tab, you can view the licensing status of various opsi Extensions. The first table on this tab provides details about the licensee, including information like name, number of active and non-active clients, and more. Further down, you will find a detailed list of opsi modules, showing data such as when a license was issued and its validity period.

At the bottom of the tab, there is an option to import new licenses in the .opsilic format. Once imported, these licenses are stored on the opsi server in the /etc/opsi/licenses directory.

The Grafana tab serves as a direct link to the Grafana dashboard. When you select this tab, the opsiconfd main dashboard on the Grafana server is either created or updated. Additionally, this action creates the opsidashboard user, who has access to the dashboard.

The opsiconfd categorizes logfiles into channels and contexts, allowing for targeted filtering of log messages. You can specify the log level for a particular channel using the log-levels parameter. For instance, setting .*:4,opsiconfd\.headers:8 logs only warnings for most channels, but logs messages in the opsiconfd.headers channel at the more detailed trace level.

For context-based filtering, use the log-filter parameter. The context client_address is mainly used in opsiconfd. For example, by setting client_address=192.168.1.1,192.168.1.2, you can filter the log to show messages related only to the clients with IP addresses 192.168.1.1 and 192.168.1.2.