OCS Inventory NG 2.x Documentation

To make it easier to read, the OCS Inventory NG documentation has been divided into 11 sections.

Prerequisites

• Libraries and Modules versions

Newbie documentation

• OCS Inventory NG - Basics

Basic documentation

• Setting up a OCS Inventory server
• Setting up manually the UNIX agent on client computers
• Setting up the UNIX agent on client computers using offical repositories
• Setting up the Windows Agent 2.X on client computers
• Setting up the MacOSX agent on client computers
• Setting up the Android Agent
• Administration of OCS Inventory NG
• Deploying database server
• Updating the server
• Understanding OCS Crontab

Deploying softwares and execute commands using OCS

Docker documentation

• Using docker image
• Deploy with kubernetes

Authentication

• Managing users profiles of the web interface
• Synchronization between OCS and LDAP

Management console and its advanced features

• Querying inventory results
• Using computers archiving capabilities
• Using computers groups
• Using assets categorization
• Using softwares categorization
• Using Wake On Lan
• Using and managing saved searches
• Managing administrative data
• Managing Web application Inventory
• Managing layouts
• Export a computer
• Configure mail notification
• Configure OCS news

Deployment

• Prerequisites to packages deployment
• Introduction and working principle
• Configuring the deployment
• Windows deployment templates
• Linux deployment templates
• MacOS deployment templates
• Developers - Creating your own templates

CVE Inventory

• Enabled and configure CVE-search reporting
• Setup matching regex for CVE-search server
• Visualize CVE Inventory history

Network Discovery with OCS Inventory NG

• Using IP discovery feature
• Using SNMP scan feature
• Managing SNMP on Web Console

OCS Tools

• OCS Inventory NG Agent Deployement Tool
• OCS Packager for Windows
• OCS Packager for MacOSX
• OCS Packager for Unix
• Ansible role for Unix Packager

Multi-site network architecture

• Using local proxy cache to deploy
• Synchronisation between OCS server master/slaves

Extras

• Secure your OCS Inventory NG Server
• Management server tuning
• Enable Powershell Support on Windows Agent
• Backup/restore of OCS Inventory NG database
• Common errors

Plugin Engine

• Plugin installer

REST API

• Introduction
• Configuration
• Autentification
• GET Routes
• POST Routes
• DELETE Routes
• PUT Routes

Developers

• XML-Format
• HOWTO create theme
• HOWTO package OCS Unix server releases
• HOWTO package OCS Unix agent releases
• HOWTO package OCS MacOSX agent releases
• HOWTO compile OCS Windows Agent

FAQ

• Can I upgrade my server from version X to the last stable version ?

  Solution: Since we made a lot of changes from 2.0 to 2.5 in the database schema. We recommend you to not upgrade your OCS from 1.0 to 2.5 and newer directly. You may need to upgrade to 2.0 before.

• After installing the server, I go to the graphical admin console (GUI) and it asks me to install the database ?

  Solution: The database is installed on the first access to the graphical admin console (GUI).

• What URL must I put in the agent to contact the server ?

  Solution: The URL must be in this form http://dns_or_ip/ocsinventory. It is recommended that you use DNS instead of IP.

• ocsinventory directory does not exist on my server

  Solution: ocsinventory is a virtual directory call by mod_perl in apache. ocsinventory directory must not exist.

• Error 500:

  Solution: OCS engine can't comunicate with mysql server. Probably due to a wrong mysql account. You have to check z-ocsinventory-server.conf exactly theses few lines

  # Master Database settings
    # Replace localhost by hostname or ip of MySQL server for WRITE
    PerlSetEnv OCS_DB_HOST localhost
    # Replace 3306 by port where running MySQL server, generally 3306
    PerlSetEnv OCS_DB_PORT 3306
    # Name of database
    PerlSetEnv OCS_DB_NAME ocsweb
    PerlSetEnv OCS_DB_LOCAL ocsweb
    # User allowed to connect to database
    PerlSetEnv OCS_DB_USER ocs
    # Password for user
    PerlSetVar OCS_DB_PWD ocs
  

  Modify OCS_DB_USER and OCS_DB_PWD with your own account, restart apache, and finaly launch an inventory.

• Error 417:

  Solution : insert ignore_expect_100 on into your squid.conf file and then run squid -k reconfigure.

Contribution

If you think something is missing feel free to open an issue or fork it and document it by yourself. Same for mistakes in the documentation.

The Github repository below is directly linked to our documentation. See our GitHub repository