Skip to main content

A CLI tool to manage Nagios Core via HTTP REST API

Project description

nagioscli

Python Version License: MIT

A CLI tool to manage Nagios Core via HTTP REST API.

Features

  • Query host and service status
  • List all problems (warning, critical, unknown)
  • Force immediate checks
  • Acknowledge problems
  • List hosts and services
  • JSON output support
  • Multiple authentication methods:
    • Basic auth (password, environment variable)
    • Password manager (pass) integration
    • Vouch Proxy (SSO/OAuth) support

Installation

# From PyPI
pip install nachos

# From source
pip install git+https://github.com/lduchosal/nagioscli.git

# Development
git clone https://github.com/lduchosal/nagioscli.git
cd nagioscli
pdm install

Quick Start

Configuration

Create nagioscli.ini in the current directory or ~/.nagioscli.ini:

[nagios]
url = http://nagios.example.com/nagios
username = nagiosadmin

[auth]
method = pass_path
pass_path = nagios/admin

[settings]
timeout = 30

Basic Usage

# List all problems
nagioscli problems

# Query service status
nagioscli status service web01.example.com HTTP

# Query host status
nagioscli status host web01.example.com

# Force service check
nagioscli check web01.example.com HTTP

# Acknowledge a problem
nagioscli ack web01.example.com HTTP "Working on it"

# List all hosts
nagioscli hosts

# List services for a host
nagioscli services web01.example.com

Commands

Command Description
problems List all services with problems
status service <host> <service> Query service status
status host <host> Query host status
check <host> <service> Force service check
check-host <host> Force host check
ack <host> <service> <comment> Acknowledge service problem
ack-host <host> <comment> Acknowledge host problem
hosts List all monitored hosts
services <host> List services for a host
login Authenticate via Vouch Proxy (SSO)
logout Clear saved authentication token

Output Options

# JSON output
nagioscli problems --json

# Quiet mode (exit codes only)
nagioscli problems --quiet

# Verbose debugging
nagioscli problems -v
nagioscli problems -vv
nagioscli problems -vvv

Configuration Options

Authentication Methods

nagioscli supports multiple authentication methods for different environments.

Basic Auth - Password in config file

[nagios]
url = http://nagios.example.com/nagios
username = admin
password = secret

Basic Auth - Password from pass (password-store)

[nagios]
url = http://nagios.example.com/nagios
username = admin

[auth]
method = pass_path
pass_path = nagios/admin

Basic Auth - Password from environment variable

[nagios]
url = http://nagios.example.com/nagios
username = admin

[auth]
method = env_var
env_var = NAGIOS_PASSWORD

Vouch Proxy (SSO/OAuth)

For Nagios behind Vouch Proxy with SSO authentication:

# Interactive login - opens browser, paste cookie from DevTools
nagioscli login

The token is cached in ~/.nagioscli_token and used automatically.

Alternatively, set the cookie directly in config:

[nagios]
url = https://nagios.example.com/nagios
username = admin

[auth]
method = vouch_cookie
vouch_cookie = H4sIAAAA...

To get the cookie value manually:

  1. Open browser to your Nagios URL
  2. Authenticate via SSO
  3. Open DevTools (F12) → Application → Cookies
  4. Copy the VouchCookie value

To logout and clear the cached token:

nagioscli logout

Exit Codes

Code Meaning
0 Success
1 General error
2 Configuration error
3 Authentication error
4 API error
5 Not found

Development

# Clone and setup
git clone https://github.com/lduchosal/nagioscli.git
cd nagioscli
pdm install -G dev

# Run tests
pdm test

# Lint and format
pdm lint
pdm format

# Type check
pdm typecheck

# Build
pdm build

Architecture

nagioscli/
├── cli/                    # Click CLI interface
│   ├── commands/           # Individual commands
│   ├── decorators.py       # Common CLI options
│   └── handlers.py         # Error handlers
├── core/                   # Core business logic
│   ├── auth.py             # Authentication
│   ├── client.py           # Nagios HTTP client
│   ├── config.py           # Configuration
│   ├── exceptions.py       # Custom exceptions
│   └── models.py           # Data models
└── services/               # Business services

License

MIT License - see LICENSE for details.

Contributing

  1. Fork the repository
  2. Create a feature branch
  3. Make your changes
  4. Run tests and linting
  5. Submit a pull request

Related Projects

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

nachos-0.1.11.tar.gz (18.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

nachos-0.1.11-py3-none-any.whl (19.5 kB view details)

Uploaded Python 3

File details

Details for the file nachos-0.1.11.tar.gz.

File metadata

  • Download URL: nachos-0.1.11.tar.gz
  • Upload date:
  • Size: 18.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: pdm/2.26.4 CPython/3.11.14 FreeBSD/14.3-RELEASE-p7

File hashes

Hashes for nachos-0.1.11.tar.gz
Algorithm Hash digest
SHA256 1a2b8ee9ac67743f94b25caa3e81b4cf6dbbfe42254e504921e93cba66455673
MD5 1ae3e2ed48ab02291e9086ad789f5745
BLAKE2b-256 d1db6c0c699630410aa3e50457db0c6d25bb70b417a60e882dd51a3a7f94aafc

See more details on using hashes here.

File details

Details for the file nachos-0.1.11-py3-none-any.whl.

File metadata

  • Download URL: nachos-0.1.11-py3-none-any.whl
  • Upload date:
  • Size: 19.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: pdm/2.26.4 CPython/3.11.14 FreeBSD/14.3-RELEASE-p7

File hashes

Hashes for nachos-0.1.11-py3-none-any.whl
Algorithm Hash digest
SHA256 5c0b92f943517463657cf77638cf4857d2695048ee1128a49636c0d9ee6ea4cb
MD5 b8875322390cda7a2d1eef149fdca57c
BLAKE2b-256 ec688f8243679bee333d771bfa18fcc72b733b00132c234acaa15b42a4481de5

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page