aboutsummaryrefslogtreecommitdiff
path: root/README.md
blob: 77003758895a132a04250ecc961c8f1f88e2edcc (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
check\_ftp
==========

This plugin makes an FTP connection to a nominated server, optionally including
a STARTTLS upgrade for FTPS.  It does not support implicit FTPS.

Installation
------------

    $ perl Makefile.PL
    $ make
    $ sudo make install

Usage
-----

    Usage: check_ftp [--hostname|h HOSTNAME] [--starttls|S [SERVERNAME]]

     -?, --usage
       Print usage information
     -h, --help
       Print detailed help screen
     -V, --version
       Print version information
     --extra-opts=[section][@file]
       Read options from an ini file. See https://www.monitoring-plugins.org/doc/extra-opts.html
       for usage and examples.
     -H, --hostname=HOSTNAME
       FTP server hostname or address
     -S, --starttls[=HOSTNAME]
       Try STARTTLS with optional specified hostname
     -t, --timeout=INTEGER
       Seconds before plugin times out (default: 15)
     -v, --verbose
       Show details for command-line debugging (can repeat up to 3 times)


Thanks
------

This was written on company time with my employer [Inspire Net][1], who has
generously allowed me to release it as free software.

License
-------

Copyright (C) 2020--2021 Tom Ryder <tom@sanctum.geek.nz>

Distributed under GNU General Public License version 3 or any later version.
Please see `COPYING`.

[1]: https://www.inspire.net.nz/