Mon 16172 improve most used helps (#4477)

* enh(help): first draft

* enh(help): second batch

* enh(help): last batch?
This commit is contained in:
omercier 2023-06-15 17:06:36 +02:00 committed by GitHub
parent 5ed5563974
commit e0922ef7f1
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 27 additions and 24 deletions

View File

@ -113,19 +113,21 @@ It can be: sshcli (default), plink and libssh.
=item B<--ssh-username>
Connect with specified username.
Define the user name to log in to the host.
=item B<--ssh-password>
Login with specified password. Cannot be used with sshcli backend.
Define the password associated with the user name.
Cannot be used with the sshcli backend.
Warning: using a password is not recommended. Use --ssh-priv-key instead.
=item B<--ssh-port>
Connect to specified port.
Define the TCP port on which SSH is listening.
=item B<--ssh-priv-key>
Private key file for user authentication.
Define the private key file to use for user authentication.
=back

View File

@ -479,28 +479,29 @@ Time to keep data in seconds (Default: 86400).
=item B<--statefile-dir>
Directory for statefile (Default: '/var/lib/centreon/centplugins').
Define the cache directory (default: '/var/lib/centreon/centplugins').
=item B<--statefile-suffix>
Add a suffix for the statefile name (Default: '').
Define a suffix to customize the statefile name (Default: '').
=item B<--statefile-concat-cwd>
Concat current working directory with option '--statefile-dir'.
Useful on Windows when plugin is compiled.
If used with the '--statefile-dir' option, the latter's value will be used as
a sub-directory of the current working directory.
Useful on Windows when the plugin is compiled, as the file system and permissions are different from Linux.
=item B<--statefile-format>
Format used to store cache (can be: 'dumper', 'storable', 'json').
Define the format used to store the cache. Available formats: 'dumper', 'storable', 'json' (default).
=item B<--statefile-key>
Key to encrypt/decrypt cache.
Define the key to encrypt/decrypt the cache.
=item B<--statefile-cipher>
Cipher to encrypt cache (Default: 'AES').
Define the cipher algorithm to encrypt the cache (Default: 'AES').
=back

View File

@ -565,55 +565,55 @@ Need at least openwsman-perl version >= 2.4.0
=item B<--hostname>
Hostname to query (required).
Define the hostname to query (mandatory).
=item B<--wsman-port>
Port (default: 5985).
Define the port to connect to (default: 5985).
=item B<--wsman-path>
Set path of URL (default: '/wsman').
Define the path of the WSMAN URL if it has been customized (default: '/wsman').
=item B<--wsman-scheme>
Set transport scheme (default: 'http').
Define the transport scheme (default: 'http').
=item B<--wsman-username>
Set username for authentification.
Define the username for authentication.
=item B<--wsman-password>
Set username password for authentification.
Define the password associated with the user name.
=item B<--wsman-timeout>
Set HTTP Transport Timeout in seconds (default: 30).
Define the HTTP transport timeout in seconds (default: 30).
=item B<--wsman-auth-method>
Set the authentification method (default: 'basic').
Define the authentication method. Available methods: noauth, basic (default), pass, digest, ntlm, gssnegotiate.
=item B<--wsman-proxy-url>
Set HTTP proxy URL.
Define the URL of the HTTP proxy to use.
=item B<--wsman-proxy-username>
Set the proxy username.
Define the user name to authenticate to the proxy server.
=item B<--wsman-proxy-password>
Set the proxy password.
Define the password to authenticate to the proxy server.
=item B<--wsman-debug>
Set openwsman debug on (Default: --wsman-debug=info).
Define the openwsman log level. Available levels: error, critical, warning, message, info (default), debug.
=item B<--wsman-errors-exit>
Exit code for wsman Errors (default: unknown)
Define the expected exit code when wsman errors occur (default: unknown).
=back