Update Icinga 2 CLI Commands Documentation #10323
Conversation
First, the "--help" output from some sections was quite outdated, sometimes manually patched. This resulted in incorrect and inconsistent information, addressed by regenerating the output for each section based on a current Icinga 2 version 2.14.4. The two subsections about "--app" and "--library" were removed, as these command line arguments were removed a while ago in 90496b5. Otherwise, only minor changes have been made.
| chapter. This CLI command is available since v2.8. | ||
| chapter. |
There was a problem hiding this comment.
Can you please state a clear question?
If you want to know why I have removed the note regarding version 2.8, than it is because this is now ancient history. This information has no benefit at this point and only confuses a reader.
| e.g. to test [functions](17-language-reference.md#functions) in your local sandbox. | ||
| e.g., to test [functions](17-language-reference.md#functions) in your local sandbox. | ||
|
|
||
| This command can be executed by any user and does not require access to the Icinga 2 configuration. |
| $ icinga2 console | ||
| Icinga 2 (version: v2.11.0) | ||
| # icinga2 console |
There was a problem hiding this comment.
... but then you shouldn't have to be root. 😅
There was a problem hiding this comment.
I wanted to keep it uniform, thus I haven chosen PS1=# for each command. Only having one with a $ prompt would be confusing, imo.
| @@ -323,20 +314,20 @@ are required for executing config expressions and auto-completion. | |||
|
|
|||
| You can specify the API URL using the `--connect` parameter. | |||
|
|
|||
| Although the password can be specified there process arguments on UNIX platforms are | |||
There was a problem hiding this comment.
But AFAIK on Windows they're invisible to others, aren't they?
There was a problem hiding this comment.
I don't know. And honestly, is this important? There are also differences on UNIX- or POSIX-like platforms, e.g., there is hidepid on Linux or namespaces and whatnot. But this is all just nitpicking.
First, the "--help" output from some sections was quite outdated, sometimes manually patched. This resulted in incorrect and inconsistent information, addressed by regenerating the output for each section based on a current Icinga 2 version 2.14.4.
The two subsections about "--app" and "--library" were removed, as these command line arguments were removed a while ago in 90496b5.
Otherwise, only minor changes have been made.