Home • Explore • Blog • Models • CI
☰



nixpkgs
nixos/modules/services/monitoring/ocsinventory-agent.md
5e987739c184d2d80b710f0e21621a41ce319f5337c571b40000000300000516
# OCS Inventory Agent {#module-services-ocsinventory-agent}

[OCS Inventory NG](https://ocsinventory-ng.org/) or Open Computers and Software inventory
is an application designed to help IT administrator to keep track of the hardware and software
configurations of computers that are installed on their network.

OCS Inventory collects information about the hardware and software of networked machines
through the **OCS Inventory Agent** program.

This NixOS module enables you to install and configure this agent so that it sends information from your computer to the OCS Inventory server.

For more technical information about OCS Inventory Agent, refer to [the Wiki documentation](https://wiki.ocsinventory-ng.org/03.Basic-documentation/Setting-up-the-UNIX-agent-manually-on-client-computers/).


## Basic Usage {#module-services-ocsinventory-agent-basic-usage}

A minimal configuration looks like this:

```nix
{
  services.ocsinventory-agent = {
    enable = true;
    settings = {
      server = "https://ocsinventory.localhost:8080/ocsinventory";
      tag = "01234567890123";
    };
  };
}
```

This configuration will periodically run the ocsinventory-agent SystemD service.

The OCS Inventory Agent will inventory the computer and then sends the results to the specified OCS Inventory Server.
Chunks
7a6a89cd (1st chunk of `nixos/modules/services/monitoring/ocsinventory-agent.md`)
Title: NixOS Module for OCS Inventory Agent
Summary
This document introduces the NixOS module for the OCS Inventory Agent, a program that collects hardware and software configuration data from networked computers for the OCS Inventory NG application. The module allows IT administrators to install and configure the agent on their NixOS machines to send inventory information to a central OCS Inventory server. A basic configuration example demonstrates enabling the service, specifying the server URL, and setting a tag, which results in the agent periodically inventorying the computer and sending the data.