GSP
Quick Navigator

Search Site

Unix VPS
A - Starter
B - Basic
C - Preferred
D - Commercial
MPS - Dedicated
Previous VPSs
* Sign Up! *

Support
Contact Us
Online Help
Handbooks
Domain Status
Man Pages

FAQ
Virtual Servers
Pricing
Billing
Technical

Network
Facilities
Connectivity
Topology Map

Miscellaneous
Server Agreement
Year 2038
Credits
 

USA Flag

 

 

Man Pages


Manual Reference Pages  -  ICLI (1)

.ds Aq ’

NAME

icli - Icinga Command Line Interface

CONTENTS

SYNOPSIS

<B>icliB> [<B>-vB>|<B>-vvB>] [<B>-zB> filter] [<B>-hB> hosts] [<B>-gB> hostgroups] [<B>-sB> services] [<B>-cB> config] [<B>-CB>] [<B>-fB> status-file] [<B>-FB> rw-file] [<B>-rB>|<B>-uB>|<B>-lhB>|<B>-lsB>|<B>-lqB>|<B>-ldB>] [host/service ...]

VERSION

version 0.47

DESCRIPTION

<B>icliB> is a command line interface to <B>IcingaB>. By default it lists all services and their states.

Note that when supplying custom config and status file paths, <B>icliB> also works with <B>NagiosB>. 100% compatibility is not guaranteed, however.

<B>icliB> only works when executed on the host running the <B>IcingaB> daemon. To use it on another host, shell aliases (like alias icli=ssh $icingahost icli) or similar are recommended.

You can narrow down the list of services you want displayed either using <B>filtersB> (like icli -z!o), the <B>-hB>/<B>-sB> arguments (icli -h aneurysm -s Libraries,Websites) or commandline args (icli aneurysm/{Libraries,Websites} with shell expansion).

OPTIONS

<B>-aB>|<B>--acknowledgeB> comment Acknowledge all matching services with string comment. This creates a sticky acknwoledgment with notification and no expire time. The comment will not be persistent.

Note: Acknowledgement of host problems is not yet supported.

<B>-cB>|<B>--configB> config Read config from file
<B>-CB>|<B>--no-coloursB> Disable colours in output
<B>-fB>|<B>--status-fileB> file Read the status from file
<B>-FB>|<B>--rw-fileB> file Use file as external commands file.
<B>-gB>|<B>--hostgroupB> hostgroup Limit selection to hosts in hostgroup (comma separated list)
<B>-hB>|<B>--hostB> hosts Limit selection to hosts (comma separated list)
<B>-lB>|<B>--listB> <B>downtimesB>|<B>hostsB>|<B>servicesB>|<B>queueB> List either services (the default) or hosts. Note that only the first character of the argument is checked, so icli -lh, icli -ls etc. are also fine.
<B>-mB>|<B>--matchB> regex Limit selection to hosts/services whose plugin output matches regex (perl regular expression, case insensitive. see perlre).
<B>-oB>|<B>--overviewB> Display tactical overview-style overview. By default (or when used with -ls) the number of all hosts and services (both total and divided by their state) is shown.

When used with -lh, lists all hosts with the number of ok / warning / ... checks on each host.

<B>-rB>|<B>--recheckB> Schedule an immediate recheck of all selected services
<B>-uB>|<B>--force-recheckB> Schedule a forced, immediate recheck of all selected services
<B>-UB>|<B>--as-contactB> name Only operate on service visible to name. Doesn’t work for <B>-lhB> yet, most useful for <B>-lsB>.

NOTE: This is meant to help find out which services a user has access to. It is NOT intended as a way to restrict access and should never be used that way.

<B>-sB>|<B>--serviceB> services Limit selection to services (comma separated lists). Can be combined with <B>-hB>/<B>-gB> to further narrow down the selection, but may also be used stand-alone.
<B>-vB>|<B>--verboseB> Increase output verbosity. Can be combined up to <B>-vvvB>
<B>-VB>|<B>--versionB> Show version information
<B>-xB>|<B>--cut-modeB> mode What to do with lines which are too long for the terminal: <B>nB>othing, <B>cB>ut off, line <B>bB>reak (with proper indentation). The default is line <B>bB>reaks
<B>-zB>|<B>--filterB> expression Limit selection to hosts/services passing the filter. expression is a comma separated list of filters, only hosts/services to which all filters apply are selected. See also FILTER EXPRESSIONS

OUTPUT

    SERVICE LISTING

This is the standard output method. It contains the following:
o Service description
o -v: Service Flags (<B>AB>cknowledged, <B>FB>lapping, <B>PB>assive, <B>!B>no checks)
o Service state (ok / warning / critical / unknown)
o -v: Current attempt / Max attempts
o Plugin output

    HOST LISTING

Enabled with -ld
o Host name
o Host state (ok / down / unreachable)
o -v: Current attempt / Max attempts
o Plugin output

    QUEUE LISTING

Enabled with -lq
o Host name
o Service name
o Last check
o Next check

FILTER EXPRESSIONS

Each expression can be negated with an exclamation mark, e.g. !A for all non-acknowledged services.
<B>AB> Check state has been acknowledged
<B>DB> The host this service belongs to is Down or Unreachable
<B>FB> Service is flapping between states
<B>NB> Notifications for this service are disabled
<B>PB> Only passive checks are enabled. Note that <B>!PB> simply means that active checks are enabled, no matter the status of passive checks
<B>SB> Check state is soft. For instance, it used to be OK and is now critical, but has not reached its maximum number and caused a notification yet. Good to find (or ignore) service problems which might just be temporary, non-critical glitches.
<B>oB> Host/Service state is OK
<B>wB> Service state is Warning
<B>cB> Service state is Critical
<B>uB> Service state is Unknown
<B>pB> Host or service state is Pending
<B>dB> Host state is Down
<B>xB> Host state is Unreachable

EXIT STATUS

Zero, unless errors occured.

CONFIGURATION

None.

DEPENDENCIES

o autodie (included with perl >= 5.10.1)
o Term::Size

BUGS AND LIMITATIONS

This software is in early development stages. So there will probably be quite a lot.

    REPORTING BUGS

Either via mail to <derf@finalrewind.org> or on <http://github.com/derf/icinga-cli/issues>.

EXAMPLES

icli -r -s APT Updates Schedule a check of the APT Updates service on all hosts having it
icli -lq -h aneurysm -g chaosdorf-hosts List check queue for all hosts in the hostgroup chaosdorf-hosts, plus the host aneurysm
icli -z!o,!A,!S,!D Show all service problems which are already hard states and have not yet been acknowledged. Also weed out problem services on hosts which are down anyways

AUTHOR

Copyright (C) 2010 by Daniel Friesel <derf@finalrewind.org>

LICENSE



  0. You just DO WHAT THE FUCK YOU WANT TO.



Search for    or go to Top of page |  Section 1 |  Main Index


perl v5.20.3 ICLI (1) 2016-04-03

Powered by GSP Visit the GSP FreeBSD Man Page Interface.
Output converted with manServer 1.07.