Name

bsadmin — send server commands to a Big Sister server

Synopsis

bsadmin [-D debuglevel ] [-d server[:port] ] [-t timeout ] [-f commandfile ] [command] [command-args ...]

bsadmin [[options]] [join group group1 ...]

bsadmin [[options]] [leave group group1 ...]

bsadmin [[options]] [remove host.check ...]

bsadmin [[options]] [displayname group ...]

bsadmin [[options]] [savelogs [tag]]

bsadmin [[options]] [archivelogs directory [days]]

bsadmin [[options]] [status host.check color text]

bsadmin [[options]] [disable host.check duration|forever text]

bsadmin [[options]] [enable host.check text]

bsadmin [[options]] [perf time host:variable value]

Description

The bsadmin sends a server command to a Big Sister server. Also, multiple commands can be put into a text file, one command per line, and be sent to the server using the -f option. The target server can be specified with the -d option, it defaults to localhost:1984.

join group group1 ...

Makes the group or host named group join one or multiple groups. Without KeepGroups option set on the server-side, group joins done via the join command will only persist until the server is re-started or the server configuration file is changed.

leave group group1 ...

Makes the group or host named group leave one or multiple groups. If one of the group arguments is an asterisk (*) rather than a group name, the host/group leaves all groups. Without KeepGroups option set on the server-side, group leaves done via the leave command will only persist until the server is re-started or the server configuration file is changed.

remove host.check ...

Makes the server forget the status for the given host (row) and check (column) pairs. Check may be an asterisk (*), in which case all the checks for this host are dropped.

[Note]Note

This drops only the remembered status color and text on the server side. If there is still an agent reporting for the host/check, then its next report will make the host/check reappear.

displayname group name

Sets the displayed name of a group or host. The display name is the name used in the first column of status tables. Configured display names in the groups section of the server configuration will override the displayname on the next server re-start or configuration re-load unless the KeepGroups option is active.

savelogs [tag]

Forces a log-rotate of the growing Big Sister logs (mainly the display.history file). The logs are stored with a file extension passed via the tag option. If no tag is given, the current date and time are used to generate one.

archivelogs directory [days]

Like savelogs, archivelogs forces a log-rotate, but as well stores the saved logs in the local directory specified on the command line.

status host.check color text

Sets the status of a host/check to the given color and text.

disable host.check duration|forever text

Sets a given host/check into maintenance mode for the given duration. The duration must either be a time in hours:minutes notation or the string forever. In place of an existing check (row) the disable command also accepts an asterisk (*) and will then disable all checks of the given host.

enable host.check text

Resets a given host/check that was set into maintenance mode and re-starts normal status reporting for it. As with the disable command, the check may also be an asterisk meaning that all the checks of the given host should be reset.

perf time host:variable value

Sends performance data to the server. The time must be a Unix time value (integer, seconds from January 1st, 1970) or 0. In the latter case the current time is associated with the value.