opsi Version 3.3.1 - opsi Download - uib

3.5.1. Overview
3. opsi configuration and tools
opsi V3 introduced an opsi owned python library which provides an API for opsi
configuration. The 'opsiconfd' provides this API as a web service, whereas 'opsi-admin'
is the command line interface for this API.
'opsi-admin' provides an interactive mode and a non interactive mode for batch
processing from within scripts.
The help option opsi-admin -h shows a list of available command line options:
# opsi-admin -h
Usage: opsi-admin [-u -p -a -d -l -f -i -c -s] [command] [args...]
-h, --help Display this text
-u, --username Username (default: current user)
-p, --password Password (default: prompt for password)
-a, --address URL of opsiconfd (default: https://localhost:4447/rpc)
-d, --direct Do not use opsiconfd
-l, --loglevel Set log level (default: 2)
0=nothing, 1=critical, 2=error, 3=warning, 4=notice,
5=info, 6=debug
-f, --log-file Path to log file
-i, --interactive Start in interactive mode
-c, --colorize Colorize output
-S, --simple-output Simple output (only for scalars, lists)
-s, --shell-output Shell output
'opsi-admin' can use the opsi web service or directly operate on the data backend. To
work with the web service you have to provide the URL and also an user name and
password. Due to security reasons you probably wouldn't like to do this from within a
script. In that case you'd prefer direct access to the data base using the -d option:
opsi-admin -d.
In interactive mode (start with opsi-admin -i or opsi-admin -d -i -c) you get input
support with the TAB-key. After some input, with the TAB-button you get a list or details
of the data type of the next expected input.
The option -s or -S generates an output format which can be easily parsed by scripts.
There are some methods which are directly based on API-requests, and there are some
'tasks', which are a collection of function calls to do a more complex special job.
27