otty / dotfiles

All tools/Zabbix-cli

Zabbix-cli

zabbix-cli

A command line interface for performing common administrative tasks in Zabbix via the Zabbix API.

Detected by zabbix-cli | macOS, Linux, Windows |github.com

Sync it zabbix-cli.toml

Sync rules

What travels, what stays, what never leaves

Zabbix-cli in your home directory Every rule on this page, by file

app.session_fileapp.auth_token_fileapp.auth_fileapp.history_filelogging.log_file

Each machine keeps its own copy of these.

api.passwordapi.auth_token

Lifted into your secret store; the rest of the file syncs.

…

[app]

use_session_file = true

session_file = "C:\\Users\\octocat\\AppData\\Local\\unioslo\\zabbix-cli\\.zabbix-cli_session.json"machine-local

auth_token_file = "C:\\Users\\octocat\\AppData\\Local\\unioslo\\zabbix-cli\\.zabbix-cli_auth_token"machine-local

use_auth_file = false

auth_file = "C:\\Users\\octocat\\AppData\\Local\\unioslo\\zabbix-cli\\.zabbix-cli_auth"machine-local

allow_insecure_auth_file = false

history = true

history_file = "C:\\Users\\octocat\\AppData\\Local\\unioslo\\zabbix-cli\\history"machine-local

bulk_mode = "strict"

legacy_json_format = false

…

[logging]

enabled = true

log_level = "INFO"

log_file = "C:\\Users\\octocat\\AppData\\Local\\unioslo\\zabbix-cli\\Logs\\zabbix-cli.log"machine-local

Each machine keeps its own copy of these.

api.passwordapi.auth_token

Lifted into your secret store; the rest of the file syncs.

· .zabbix-cli_auth Never synced

· .zabbix-cli_auth_token Never synced

· .zabbix-cli_session.json Never synced

· ~/.zabbix-cli/zabbix-cli.conf Sync

· ~/.zabbix-cli_auth Never synced

· ~/.zabbix-cli_auth_token Never synced

· .zabbix-cli_auth Never synced

· .zabbix-cli_auth_token Never synced

· .zabbix-cli_session.json Never synced

Only what the catalog names. A directory that syncs brings everything inside it except what is listed as excluded here.

apps/zabbix-cli.tomlThe file this page is generated from

id = "zabbix-cli"

name = "Zabbix-cli"

homepage = "https://github.com/unioslo/zabbix-cli"

description = "A command line interface for performing common administrative tasks in Zabbix via the Zabbix API."

# zabbix-cli publishes no mark of its own; this is the logo of Zabbix, the

# service it drives.

icon = "theSVG:zabbix"

detect = ["zabbix-cli"]

# https://unioslo.github.io/zabbix-cli/guide/configuration/ lists the search

# order per platform; zabbix_cli/config/constants.py is where it comes from —

# `CONFIG_FILENAME = "zabbix-cli.toml"`, `DEFAULT_CONFIG_FILE = CONFIG_DIR /

# CONFIG_FILENAME`, and `CONFIG_PRIORITY` is (current directory, that file, the

# system config directory). zabbix_cli/dirs.py defines `CONFIG_DIR =

# PlatformDirs(APP_NAME, AUTHOR).user_config_path` with APP_NAME "zabbix-cli"

# and AUTHOR "unioslo" (zabbix_cli/__about__.py). platformdirs' user config

# directory is $XDG_CONFIG_HOME/zabbix-cli on Linux and

# ~/Library/Application Support/zabbix-cli on macOS — that pair is [appData].

# Windows is spelled out separately because platformdirs inserts the author

# there: windows.py's `user_config_dir` returns `user_data_dir`, which is

# CSIDL_LOCAL_APPDATA passed through `_append_parts`, and `_append_parts`

# prepends the author whenever `appauthor is not False`. So the file is

# %LOCALAPPDATA%\unioslo\zabbix-cli\zabbix-cli.toml. (The docs page prints it

# without the author segment; the code is what runs.) On Windows the [appData]

# line above resolves to %APPDATA%\zabbix-cli, which zabbix-cli does not use,

# and the /etc/xdg copy is system-wide and left out.

# zabbix_cli/_v2_compat.py keeps the v2 location alive: `CONFIG_USER_DIR =

# os.path.expanduser("~/.zabbix-cli")` with `CONFIG_FILENAME =

# "zabbix-cli.conf"`, an INI file read with ConfigParser

# (config/utils.py, `load_config_conf`). A consumer skips whichever is absent.

paths = [

"[appData]/zabbix-cli/zabbix-cli.toml",

"%LOCALAPPDATA%/unioslo/zabbix-cli/zabbix-cli.toml",

"~/.zabbix-cli/zabbix-cli.conf",

]

exclude = []

# constants.py names three credential files, all under `DATA_DIR`

# (`PlatformDirs(...).user_data_path`, which is [dataHome]): `AUTH_TOKEN_FILE =

# DATA_DIR / ".zabbix-cli_auth_token"` ("Path to file containing API session

# token"), `AUTH_FILE = DATA_DIR / ".zabbix-cli_auth"` ("Path to file

# containing user credentials"), and `SESSION_FILE = DATA_DIR /

# ".zabbix-cli_session.json"` ("Path to JSON file containing API session IDs").

# Each is a credential end to end.

# The %LOCALAPPDATA%\unioslo copies are the same three files on Windows, where

# platformdirs' data directory carries the author segment the way the config

# directory does — [dataHome] alone would resolve to %LOCALAPPDATA%\zabbix-cli

# and the rule would not run, which for a credential means syncing it in the

# clear. The two in the home directory are the v2 spellings: _v2_compat.py has

# `AUTH_FILE = Path.home() / ".zabbix-cli_auth"` and `AUTH_TOKEN_FILE =

# Path.home() / ".zabbix-cli_auth_token"`.

secret = [

"[dataHome]/zabbix-cli/.zabbix-cli_auth",

"[dataHome]/zabbix-cli/.zabbix-cli_auth_token",

"[dataHome]/zabbix-cli/.zabbix-cli_session.json",

"%LOCALAPPDATA%/unioslo/zabbix-cli/.zabbix-cli_auth",

"%LOCALAPPDATA%/unioslo/zabbix-cli/.zabbix-cli_auth_token",

"%LOCALAPPDATA%/unioslo/zabbix-cli/.zabbix-cli_session.json",

"~/.zabbix-cli_auth",

"~/.zabbix-cli_auth_token",

]

# zabbix-cli.toml is not a whole-file secret — the server URL, output format,

# default host groups and export settings are worth carrying — but the [api]

# table holds the login. config/model.py's `APIConfig` declares `password:

# SecretStr` ("Password for user") and `auth_token: SecretStr` ("API auth

# token") beside the plain `url` and `username`. Both spellings of the file, or

# the credential is only lifted out on Unix.

[[secret_paths]]

file = [

"[appData]/zabbix-cli/zabbix-cli.toml",

"%LOCALAPPDATA%/unioslo/zabbix-cli/zabbix-cli.toml",

]

match = { key_path = ["api.password", "api.auth_token"] }

# Every one of these is an absolute path built from this machine's data or log

# directory: `AppConfig` declares session_file, auth_token_file, auth_file and

# history_file as `Path` fields defaulting to constants.py's `DATA_DIR / …`,

# and `LoggingConfig.log_file` defaults to `LOGS_DIR / "zabbix-cli.log"`. The

# written file therefore carries this user's home directory and this

# platform's directory layout, which is not what the next machine needs.

[[machine_lines]]

file = [

"[appData]/zabbix-cli/zabbix-cli.toml",

"%LOCALAPPDATA%/unioslo/zabbix-cli/zabbix-cli.toml",

]

match = { key_path = [

"app.session_file",

"app.auth_token_file",

"app.auth_file",

"app.history_file",

"logging.log_file",

] }

Use it with your dotfile manager

Same data, in the shape your tool already reads

Opens Otty and adds this tool to what it syncs

Opens otty://sync/add/zabbix-cli. Otty ships with this catalog, so the link only has to name the tool — nothing is downloaded.

Every one of these keeps all credential files out. None of them splits app.session_file and app.auth_token_file for you — that part is Otty’s own sync, or a template you write by hand.