sysdb(1) Manual Page

NAME

sysdb - interactive client for the system management and inventory collection service

SYNOPSIS

sysdb [options]

DESCRIPTION

sysdb is a terminal-based, interactive client program for SysDB, a multi-backend system management and inventory collection daemon. It connects to a running daemon and then accepts commands from the user, send them to the server, and display the result.

OPTIONS

sysdb accepts the following command-line options.

Connection options:

-H <host>: The SysDB host to connect to. May be specified as the path to a UNIX socket opened by the daemon. Defaults to /opt/sysdb/var/run/sysdbd.sock.
-U <username>: The username used to authenticate against the server. Defaults to the current user.
-c <command>: Send the specified command to the server after authenticating. This option may be used multiple times. Each command will be send to the server separately. Exit the process after handling the reply from the last command.

SSL options:

-K <keyfile>: The SSL private key file to use for SSL connections.
-C <certfile>: The SSL certificate file to use for SSL connections.
-A <cafile>: The certificate authority (CA) certificates file for server certificate verification to use for SSL connection.

General options:

-h: Display a usage and help summary and exit.
-V: Display the version number and copyright information.

AUTHENTICATION

SysDB requires all client connections to a database server to be authenticated. The following authentication mechanism are supported at this time:

Peer authentication for UNIX domain socket connections: Connections via UNIX domain sockets are authenticated by obtaining the client’s operating system user name from the kernel. The name has to match the username used to connect to the server.
SSL certificate authentication for TCP connection: SSL client certificates will be used to authenticate TCP connections. The cn (common name) attribute of the certificate has to match the username used to connect to the server. Note that full client and server verification is currently enforced on all TCP connections.

EXIT CODES

0: Success.
1: Failure (syntax or usage error). When using the -c option, sysdb exits with status 1 if the specified command failed.

FILES

~/.config/sysdb/ssl/key.pem
~/.config/sysdb/ssl/cert.pem: The default SSL private key and certificate files to use for SSL connections.
~/.sysdb_history: The command-line history is stored in this file.

BUGS

None known.

AUTHOR

SysDB was written by Sebastian "tokkee" Harl <sh@tokkee.org>.

COPYRIGHT

This is free software under the terms of the BSD license, see the source for copying conditions. There is NO WARRANTY; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.

Latest Releases:

» 0.8.0 — 2016-02-25
» 0.7.0 — 2015-02-21
» 0.6.0 — 2014-11-17