summaryrefslogtreecommitdiffstats
path: root/docs/aoa
diff options
context:
space:
mode:
authornicolargo <nicolashennion@gmail.com>2016-06-25 16:47:02 +0200
committernicolargo <nicolashennion@gmail.com>2016-06-25 16:47:02 +0200
commita340a5e5e13cb3a1705c83bb244e58cfa5fa13c4 (patch)
treeb09036e5904c6dab14c9a4802821453e1e14c2b2 /docs/aoa
parent3b5e11441eb5d703748642b33426c83371f3c09a (diff)
Finalize New Ports Scanner plugin (issue#734)
Diffstat (limited to 'docs/aoa')
-rw-r--r--docs/aoa/ports.rst24
1 files changed, 16 insertions, 8 deletions
diff --git a/docs/aoa/ports.rst b/docs/aoa/ports.rst
index c615d84d..7e25a38b 100644
--- a/docs/aoa/ports.rst
+++ b/docs/aoa/ports.rst
@@ -17,20 +17,28 @@ The list should be define in the ``[ports]`` section of the Glances configuratio
[ports]
# Ports scanner plugin configuration
- # Interval in second between scan
+ # Interval in second between two scans
refresh=30
- # Set the default timeout for a scan (can be overwrite in the scan list)
+ # Set the default timeout (in second) for a scan (can be overwrite in the scan list)
timeout=3
- # If True, add the default gateway on top of the scan list
+ # If port_default_gateway is True, add the default gateway on top of the scan list
port_default_gateway=True
- # Define the scan list
- # host (name or IP) is mandatory
- # port (TCP port number) is optional (if not set, use ICMP)
- # description is optional (if not set, define to host:port)
+ # Define the scan list (1 < x < 255)
+ # port_x_host (name or IP) is mandatory
+ # port_x_port (TCP port number) is optional (if not set, use ICMP)
+ # port_x_description is optional (if not set, define to host:port)
+ # port_x_timeout is optional and overwrite the default timeout value
+ # port_x_rtt_warning is optional and defines the warning threshold in ms
port_1_host=192.168.0.1
port_1_port=80
port_1_description=Home Box
+ port_1_timeout=1
port_2_host=www.free.fr
port_2_description=My ISP
port_3_host=www.google.com
- port_3_description=Internet
+ port_3_description=Internet ICMP
+ port_3_rtt_warning=1000
+ port_4_host=www.google.com
+ port_4_description=Internet Web
+ port_4_port=80
+ port_4_rtt_warning=1000