itopcli

ITopcli is a python program to query (read-only) the popular ITIL tool Combodo iTop ITSM Software. Currently this focuses on the Configuration Management aspect of the software. I'll continue to work on other areas.

    Usage: itopcli [OPTIONS] COMMAND [ARGS]...

    Options:
    --help  Show this message and exit.

    Commands:
    configure  Configure itopcli options.
    query      Query classes (core/get) in iTop

Support

ITop Version 3.x +

Note - I have tested this in ITop 2.x versions also with no issues.

OS	Success
Ubuntu 22.04 + Python3.5+	Yes
Ubuntu 20.04 + Python3.5+	Yes
Ubuntu 18.04 + Python3.5+	Yes
Ubuntu 16.04 + Python3.5+	Yes
Windows + Python3.5+	Yes

Installation

sudo apt install python3-pip -y
git clone https://github.com/thomasliddledba/itopcli.git
cd itopcli/
pip3 install -r requirements.txt
chmod +x ./itopcli

Configure

Usage

Usage: itopcli configure [OPTIONS]

  Configure itopcli options.  This command takes arguments. Use the 'itopcli
  --help' command to get a list of arguments.

  Notes:

  The user configured to use this client tool must be part of the Profile
  called 'REST Services User' within iTop.

Options:
  --location TEXT         Location of iTopcli configuration file  [required]
  --url TEXT              Root Domain name of iTop Server  [required]
  --apisuffix TEXT        Web Context location of rest.php  [required]
  --apiversion [1.2|1.3]  Supported iTop REST Version  [required]
  --organization TEXT     Default iTop Organization (For future use)
  --timeout INTEGER       HTTP Timeout  [required]
  --username TEXT         User Name for REST User  [required]
  --password TEXT         Password for REST User  [required]
  --help                  Show this message and exit.

Create config file

./itopcli configure \
--location=".itopcli" \
--url="http://localhost:8000" \
--apisuffix="/webservices/rest.php" \
--apiversion="1.3" \
--organization="Demo" \
--timeout=10 \
--username="admin" \
--password="MyAdminPassword1!"

Usage

Query Command

This client produces JSON for every query (even errors). You can format the JSON to your specs using the popular (jq) command. You can specify the --outputfields to list specific fields you would like to have displayed. The default is * or all fields.

The class, attribute, and criteria are based on iTop's object schema. The object schema is found in the software under Administration>Data Model. I tried to mimic the iTop Data Model in this tool closely.

If specified in the same command, the --key option precedes the --criteria option.

Usage

Usage: itopcli query [OPTIONS]

  Query classes (core/get) in iTop.

  Notes:

  The --key option takes precedence over --criteria option

Options:
  --class TEXT         iTop Server Class  [required]
  --attribute TEXT     Attribute code for iTop Class  [required]
  --criteria TEXT      Search criteria for iTop Class Attribute
  --key INTEGER        Key number of Attribute (Must be integer)
  --outputfields TEXT  Fields to be displayed in JSON (Comma-separated)
  --help               Show this message and exit.

Get All Records

./itopcli query --class='Server' --attribute='name' --criteria='*' --outputfields='*'

{
  "objects": {
    "Server::1": {
      "code": 0,
      "message": "",
      "class": "Server",
      "key": "1",
      "fields": {
        "name": "Server1",
        "description": "",
...
    },
    "Server::2": {
      "code": 0,
      "message": "",
      "class": "Server",
      "key": "2",
      "fields": {
        "name": "Server2",
        "description": ""
        ...
      },
      ...
  },
{
  "code": 0,
  "message": "Found: 4"
}

Query Specific Records

./itopcli query --class='Server' --attribute='name' --criteria='Server1' --outputfields='*'

{
  "objects": {
    "Server::1": {
      "code": 0,
      "message": "",
      "class": "Server",
      "key": "1",
      "fields": {
        "name": "Server1",
        ...
      }
  },
{
  "code": 0,
  "message": "Found: 1"
}

Query Specific Records with target data fields

./itopcli query --class='Server' --attribute='name' --criteria='Server1' --outputfields='name, status'

{
 "objects": {
   "Server::1": {
     "code": 0,
     "message": "",
     "class": "Server",
     "key": "1",
     "fields": {
       "name": "Server1",
       "status": "production"
     }
   }
 },
 "code": 0,
 "message": "Found: 1"
}

How to Contribute

I'd love for anyone to contribute. Please read the CONTRIBUTING.md document for more information.