doc(helps sections): Correct helps sections CTOR-962 (#5358)

CTOR-962
This commit is contained in:
Lucie Dubrunfaut 2024-12-18 09:05:50 +01:00 committed by GitHub
parent 3953f8dbb5
commit 9e8334caba
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
9 changed files with 31 additions and 21 deletions

View File

@ -424,7 +424,7 @@ Display traffic perfdata to be compatible with NagVis widget.
=item B<--interface> =item B<--interface>
Define the interface filter on IDs (OID indexes, e.g.: 1,2,...). If empty, all interfaces will be monitored. Check only the interfaces with the specified IDs (OID indexes, e.g.: 1,2,...). If empty, all interfaces will be monitored.
To filter on interface names, see --name. To filter on interface names, see --name.
=item B<--name> =item B<--name>
@ -449,7 +449,7 @@ Set interface speed for outgoing traffic (in Mb).
=item B<--force-counters32> =item B<--force-counters32>
Force to use 32-bits counters (even with SNMP versions 2c and 3). To use when 64 bits counters are buggy. Force to use 32-bit counters (even with SNMP versions 2c and 3). To use when 64 bits counters are buggy.
=item B<--reload-cache-time> =item B<--reload-cache-time>

View File

@ -1546,7 +1546,7 @@ into 'used_prct'=26.93%;0:80;0:90;0;100 'used_prct_max'=100%;;;;
=item B<--change-perfdata> B<--extend-perfdata> =item B<--change-perfdata> B<--extend-perfdata>
Change or extend perfdata. Change or extend perfdata.
Syntax: --extend-perfdata=searchlabel,newlabel,target[,[newuom],[min],[max]] Syntax: --extend-perfdata=searchlabel,newlabel,target[,[<new-unit-of-mesure>],[min],[max]]
Common examples: Common examples:
@ -1567,11 +1567,11 @@ Change traffic values in percent: --change-perfdata='traffic_in,,percent()'
=item B<--extend-perfdata-group> =item B<--extend-perfdata-group>
Add new aggregated metrics (min, max, average or sum) for groups of metrics defined by a regex match on the metrics' names. Add new aggregated metrics (min, max, average or sum) for groups of metrics defined by a regex match on the metrics' names.
Syntax: --extend-perfdata-group=regex,namesofnewmetrics,calculation[,[newuom],[min],[max]] Syntax: --extend-perfdata-group=regex,<names-of-new-metrics>,calculation[,[<new-unit-of-mesure>],[min],[max]]
regex: regular expression regex: regular expression
namesofnewmetrics: how the new metrics' names are composed (can use $1, $2... for groups defined by () in regex). <names-of-new-metrics>: how the new metrics' names are composed (can use $1, $2... for groups defined by () in regex).
calculation: how the values of the new metrics should be calculated calculation: how the values of the new metrics should be calculated
newuom (optional): unit of measure for the new metrics <new-unit-of-mesure> (optional): unit of measure for the new metrics
min (optional): lowest value the metrics can reach min (optional): lowest value the metrics can reach
max (optional): highest value the metrics can reach max (optional): highest value the metrics can reach
@ -1640,8 +1640,8 @@ format).
=item B<--output-file> =item B<--output-file>
Write output in file (can be combined with json, xml and openmetrics options). Write output in file (can be combined with JSON, XML and OpenMetrics options).
E.g.: --output-file=/tmp/output.txt will write the output in /tmp/output.txt. Example: --output-file=/tmp/output.txt will write the output in /tmp/output.txt.
=item B<--disco-format> =item B<--disco-format>

View File

@ -45,7 +45,7 @@ Check system CPUs.
=item B<--use-ucd> =item B<--use-ucd>
Use UCD mib for CPU average. Use UCD MIB for CPU average.
=item B<--warning-average> =item B<--warning-average>

View File

@ -138,7 +138,7 @@ of time that this processor was not idle)
=item B<--use-ucd> =item B<--use-ucd>
Use UCD mib for CPU average. Use UCD MIB for CPU average.
=item B<--warning-average> =item B<--warning-average>

View File

@ -304,7 +304,7 @@ __END__
=head1 MODE =head1 MODE
Check read/write I/O disks (bytes per second, IOPs). Check read/write I/O disks (bytes per second, IOPS).
=over 8 =over 8
@ -324,11 +324,11 @@ Can be: 'read', 'write', 'read-iops', 'write-iops',
=item B<--device> =item B<--device>
Set the device (number expected) example: 1, 2,... (empty means 'check all devices'). Specify the device to be checked (number expected) example: 1, 2,... (empty means 'check all devices').
=item B<--name> =item B<--name>
Allows to use device name with option --device instead of devoce oid index. Allows to use device name with option --device instead of device OID index.
=item B<--regexp> =item B<--regexp>

View File

@ -191,15 +191,15 @@ Critical threshold in percent.
=item B<--diskpath> =item B<--diskpath>
Set the disk path (number expected) example: 1, 2,... (empty means 'check all disks path'). Specify the path of the disk you want to check (number expected) example: 1, 2,... (empty means 'check all disks path').
=item B<--name> =item B<--name>
Allows to use disk path name with option --diskpath instead of disk path oid index. Allows to use disk path name with option --diskpath instead of disk path OID index.
=item B<--regexp> =item B<--regexp>
Allows to use regexp to filter diskpath (with option --name). Allows to use regexp to filter disk path (with option --name).
=item B<--regexp-insensitive> =item B<--regexp-insensitive>

View File

@ -1694,7 +1694,7 @@ Display traffic perfdata to be compatible with NagVis widget.
=item B<--interface> =item B<--interface>
Define the interface filter on IDs (OID indexes, e.g.: 1,2,...). If empty, all interfaces will be monitored. Check only the interfaces with the specified IDs (OID indexes, e.g.: 1,2,...). If empty, all interfaces will be monitored.
To filter on interface names, see --name. To filter on interface names, see --name.
=item B<--name> =item B<--name>
@ -1731,7 +1731,7 @@ Force to use 64 bits counters only. Can be used to improve performance.
=item B<--force-counters32> =item B<--force-counters32>
Force to use 32-bits counters (even with SNMP versions 2c and 3). To use when 64 bits counters are buggy. Force to use 32-bit counters (even with SNMP versions 2c and 3). To use when 64 bits counters are buggy.
=item B<--reload-cache-time> =item B<--reload-cache-time>

View File

@ -211,15 +211,15 @@ Need to enable "includeAllDisks 10%" on snmpd.conf.
=item B<--diskpath> =item B<--diskpath>
Set the disk path (number expected) example: 1, 2,... (empty means 'check all disks path'). Specify the path of the disk you want to check (number expected) example: 1, 2,... (empty means 'check all disks path').
=item B<--name> =item B<--name>
Allows to use disk path name with option --diskpath instead of disk path oid index. Allows to use disk path name with option --diskpath instead of disk path OID index.
=item B<--regexp> =item B<--regexp>
Allows to use regexp to filter diskpath (with option --name). Allows to use regexp to filter disk path (with option --name).
=item B<--regexp-insensitive> =item B<--regexp-insensitive>

View File

@ -23,14 +23,17 @@ centreon
Centreon Centreon
centreonvault centreonvault
CloudWatch CloudWatch
CPUs
Datacore Datacore
datasource datasource
DC4 DC4
dcdiag dcdiag
deduplication deduplication
deltaps deltaps
dev
df df
dfsrevent dfsrevent
--diskpath
dns-resolve-time dns-resolve-time
-EncodedCommand -EncodedCommand
env env
@ -46,6 +49,7 @@ hashicorpvault
HPE HPE
Huawei Huawei
ifAlias ifAlias
includeAllDisks
ifDesc ifDesc
ifName ifName
IMEI IMEI
@ -56,6 +60,7 @@ in-mcast
-InputFormat -InputFormat
InterrupibleSleep InterrupibleSleep
in-ucast in-ucast
iops
IpAddr IpAddr
ipv4 ipv4
ipv6 ipv6
@ -75,6 +80,7 @@ ldap
Loggly Loggly
machineaccount machineaccount
MBean MBean
Mbps
McAfee McAfee
memAvailReal memAvailReal
memBuffer memBuffer
@ -98,6 +104,7 @@ OID
OIDs OIDs
okta okta
oneaccess-sys-mib oneaccess-sys-mib
OpenMetrics
out-bcast out-bcast
out-fc-wait out-fc-wait
out-mcast out-mcast
@ -124,6 +131,7 @@ scenarii
sfp.temperature sfp.temperature
SkyHigh SkyHigh
SNMP SNMP
snmpd.conf
SSDCapacity SSDCapacity
SSH SSH
statefile statefile
@ -136,6 +144,8 @@ Teldat
timeframe timeframe
TiMOS TiMOS
tmnxSasAlarmInputDescription tmnxSasAlarmInputDescription
total-oper-up
total-oper-down
TrendMicro TrendMicro
tsdb-version tsdb-version
UCD UCD