Skip to content

Commit 3252869

Browse files
committed
chore: include manual fixes (READMEs, director baskets)
1 parent 00ac2b4 commit 3252869

File tree

6 files changed

+60
-18
lines changed

6 files changed

+60
-18
lines changed

check-plugins/by-ssh/icingaweb2-module-director/by-ssh.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -458,7 +458,7 @@
458458
"3": {
459459
"varname": "by_ssh_configfile",
460460
"caption": "By SSH: Configfile",
461-
"description": "SSH: Specifies an alternative per-user configuration file. If a configuration file is given on the command line, the system-wide configuration file (`/etc/ssh/ssh_config`) will be ignored. The default for the per-user configuration file is `~/.ssh/config`. If set to `none`, no configuration files will be read.",
461+
"description": "SSH: Alternative per-user configuration file. If a configuration file is given on the command line, the system-wide configuration file (`/etc/ssh/ssh_config`) will be ignored. The default for the per-user configuration file is `~/.ssh/config`. If set to `none`, no configuration files will be read.",
462462
"datatype": "Icinga\\Module\\Director\\DataType\\DataTypeString",
463463
"format": null,
464464
"settings": {
@@ -522,7 +522,7 @@
522522
"9": {
523523
"varname": "by_ssh_identity",
524524
"caption": "By SSH: Identity",
525-
"description": "SSH: Selects a file from which the identity (private key) for public key authentication is read. You can also specify a public key file to use the corresponding private key that is loaded in ssh-agent(1) when the private key file is not present locally. The default is `~/.ssh/id_dsa`, `~/.ssh/id_ecdsa`, `~/.ssh/id_ecdsa_sk`, `~/.ssh/id_ed25519`, `~/.ssh/id_ed25519_sk` and `~/.ssh/id_rsa`. Identity files may also be specified on a per-host basis in the configuration file. It is possible to have multiple --identity options (and multiple identities specified in configuration files). If no certificates have been explicitly specified by the CertificateFile directive, ssh will also try to load certificate information from the filename obtained by appending `-cert.pub` to identity filenames.",
525+
"description": "SSH: File from which the identity (private key) for public key authentication is read. You can also specify a public key file to use the corresponding private key that is loaded in ssh-agent(1) when the private key file is not present locally. The default is `~/.ssh/id_dsa`, `~/.ssh/id_ecdsa`, `~/.ssh/id_ecdsa_sk`, `~/.ssh/id_ed25519`, `~/.ssh/id_ed25519_sk` and `~/.ssh/id_rsa`. Identity files may also be specified on a per-host basis in the configuration file. It is possible to have multiple --identity options (and multiple identities specified in configuration files). If no certificates have been explicitly specified by the CertificateFile directive, ssh will also try to load certificate information from the filename obtained by appending `-cert.pub` to identity filenames.",
526526
"datatype": "Icinga\\Module\\Director\\DataType\\DataTypeArray",
527527
"format": null,
528528
"settings": {

check-plugins/csv-values/icingaweb2-module-director/csv-values.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -332,7 +332,7 @@
332332
"7": {
333333
"varname": "csv_values_filename",
334334
"caption": "Csv Values: Filename",
335-
"description": "Path to CSV file. This is mutually exclusive with -u / --url.",
335+
"description": "Path to CSV file. Mutually exclusive with --url.",
336336
"datatype": "Icinga\\Module\\Director\\DataType\\DataTypeString",
337337
"format": null,
338338
"settings": {

check-plugins/dhcp-scope-usage/icingaweb2-module-director/dhcp-scope-usage.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -400,7 +400,7 @@
400400
"3": {
401401
"varname": "dhcp_scope_usage_hostname",
402402
"caption": "Dhcp Scope Usage: Hostname",
403-
"description": "Specifies the DNS name, or IPv4 or IPv6 address, of the target computer that runs the DHCP server service.",
403+
"description": "DNS name, IPv4, or IPv6 address of the DHCP server.",
404404
"datatype": "Icinga\\Module\\Director\\DataType\\DataTypeString",
405405
"format": null,
406406
"settings": {
@@ -499,7 +499,7 @@
499499
"12": {
500500
"varname": "dhcp_scope_usage_windows_hostname",
501501
"caption": "Dhcp Scope Usage: Hostname",
502-
"description": "Specifies the DNS name, or IPv4 or IPv6 address, of the target computer that runs the DHCP server service.",
502+
"description": "DNS name, IPv4, or IPv6 address of the DHCP server.",
503503
"datatype": "Icinga\\Module\\Director\\DataType\\DataTypeString",
504504
"format": null,
505505
"settings": {

check-plugins/network-port-tcp/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -31,10 +31,10 @@ Checks whether a TCP network port is reachable by attempting to establish a conn
3131

3232
```text
3333
Traceback (most recent call last):
34-
File "/home/markusfrei/git/linuxfabrik/github/monitoring-plugins/check-plugins/network-port-tcp/network-port-tcp", line 141, in 'module'
34+
File "/home/markusfrei/git/linuxfabrik/github/monitoring-plugins/check-plugins/network-port-tcp/network-port-tcp", line 140, in 'module'
3535
main()
3636
~~~~^^
37-
File "/home/markusfrei/git/linuxfabrik/github/monitoring-plugins/check-plugins/network-port-tcp/network-port-tcp", line 105, in main
37+
File "/home/markusfrei/git/linuxfabrik/github/monitoring-plugins/check-plugins/network-port-tcp/network-port-tcp", line 104, in main
3838
args = parse_args()
3939
File "/home/markusfrei/git/linuxfabrik/github/monitoring-plugins/check-plugins/network-port-tcp/network-port-tcp", line 72, in parse_args
4040
help=lib.args.help('--severity') + ' Default: %(default)s',

check-plugins/systemd-unit/README.md

Lines changed: 52 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -33,16 +33,58 @@ Checks the state of a specific systemd unit (service, socket, device, mount, tim
3333
## Help
3434

3535
```text
36-
Traceback (most recent call last):
37-
File "/home/markusfrei/git/linuxfabrik/github/monitoring-plugins/check-plugins/systemd-unit/systemd-unit", line 317, in 'module'
38-
main()
39-
~~~~^^
40-
File "/home/markusfrei/git/linuxfabrik/github/monitoring-plugins/check-plugins/systemd-unit/systemd-unit", line 215, in main
41-
args = parse_args()
42-
File "/home/markusfrei/git/linuxfabrik/github/monitoring-plugins/check-plugins/systemd-unit/systemd-unit", line 102, in parse_args
43-
help=lib.args.help('--severity') + ' Default: %(default)s',
44-
^^^^^^^^
45-
AttributeError: module 'lib' has no attribute 'args'
36+
usage: systemd-unit [-h] [-V]
37+
[--activestate {None,activating,active,deactivating,failed,inactive}]
38+
[--loadstate {None,activating,active,deactivating,failed,inactive,loaded,maintenance,masked,not-found,reloading}]
39+
[--machine MACHINE] [--severity {warn,crit}]
40+
[--substate {None,abandoned,activating,activating-done,active,auto-restart,cleaning,condition,deactivating,deactivating-sigkill,deactivating-sigterm,dead,elapsed,exited,failed,final-sigkill,final-sigterm,final-watchdog,listening,mounted,mounting,mounting-done,plugged,reload,remounting,remounting-sigkill,remounting-sigterm,running,start,start-chown,start-post,start-pre,stop,stop-post,stop-pre,stop-pre-sigkill,stop-pre-sigterm,stop-sigkill,stop-sigterm,stop-watchdog,tentative,unmounting,unmounting-sigkill,unmounting-sigterm,waiting}]
41+
--unit UNIT
42+
[--unitfilestate {None,bad,disabled,empty,enabled,enabled-runtime,generated,indirect,linked,linked-runtime,masked,masked-runtime,static,transient}]
43+
[--user]
44+
45+
Checks the state of a specific systemd unit (service, socket, device, mount,
46+
timer, scope, etc.) via systemctl. Verifies the active state, sub-state, load
47+
state, and unit file state against expected values. Alerts when the unit is
48+
not in the expected state. Requires root or sudo.
49+
50+
options:
51+
-h, --help show this help message and exit
52+
-V, --version show program's version number and exit
53+
--activestate {None,activating,active,deactivating,failed,inactive}
54+
Expected systemd ActiveState (high-level unit
55+
activation state, i.e. generalization of SUB). Can be
56+
specified multiple times. If omitted or set to "None",
57+
the unit's active state will not be checked.
58+
--loadstate {None,activating,active,deactivating,failed,inactive,loaded,maintenance,masked,not-found,reloading}
59+
Expected systemd LoadState, reflecting whether the
60+
unit definition was properly loaded. If omitted or set
61+
to "None", the unit's load state will not be checked.
62+
Default: loaded
63+
--machine MACHINE Execute operation on a local container. Specify a
64+
container name to connect to, optionally prefixed by a
65+
user name and a separating "@" character. The special
66+
string ".host" connects to the local system (useful
67+
for reaching a specific user's bus: `--user
68+
--machine=lennart@.host`). Without "@" syntax, the
69+
connection is made as root. With "@" syntax, either
70+
side may be omitted (but not both), defaulting to the
71+
local user name and ".host".
72+
--severity {warn,crit}
73+
Severity for alerting. Default: warn
74+
--substate {None,abandoned,activating,activating-done,active,auto-restart,cleaning,condition,deactivating,deactivating-sigkill,deactivating-sigterm,dead,elapsed,exited,failed,final-sigkill,final-sigterm,final-watchdog,listening,mounted,mounting,mounting-done,plugged,reload,remounting,remounting-sigkill,remounting-sigterm,running,start,start-chown,start-post,start-pre,stop,stop-post,stop-pre,stop-pre-sigkill,stop-pre-sigterm,stop-sigkill,stop-sigterm,stop-watchdog,tentative,unmounting,unmounting-sigkill,unmounting-sigterm,waiting}
75+
Expected systemd SubState (low-level unit activation
76+
state; values depend on unit type). Can be specified
77+
multiple times. If omitted or set to "None", the
78+
unit's substate will not be checked.
79+
--unit UNIT Systemd unit name to check (service, timer, mount,
80+
etc.). Required. Example: `--unit sshd.service`.
81+
--unitfilestate {None,bad,disabled,empty,enabled,enabled-runtime,generated,indirect,linked,linked-runtime,masked,masked-runtime,static,transient}
82+
Expected systemd UnitFileState. If set to "empty",
83+
checks exactly for `UnitFileState=""`. If omitted or
84+
set to "None", the unit's unit-file state will not be
85+
checked.
86+
--user Talk to the service manager of the calling user rather
87+
than the service manager of the system.
4688
```
4789

4890

check-plugins/xca-cert/icingaweb2-module-director/xca-cert.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -133,7 +133,7 @@
133133
"2": {
134134
"varname": "xca_cert_defaults_file",
135135
"caption": "XCA Cert: Defaults File",
136-
"description": "Specifies a cnf file to read parameters like user, host and password from (for MySQL/MariaDB cnf-style files). Example: `/var/spool/icinga2/.my.cnf`.",
136+
"description": "Specifies a cnf file to read parameters like user, host and password from (for MySQL/MariaDB cnf-style files). (for MySQL/MariaDB cnf-style files). Example: `/var/spool/icinga2/.my.cnf`.",
137137
"datatype": "Icinga\\Module\\Director\\DataType\\DataTypeString",
138138
"format": null,
139139
"settings": {

0 commit comments

Comments
 (0)