Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update Icinga 2 CLI Commands Documentation #10323

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

oxzi
Copy link
Member

@oxzi oxzi commented Jan 24, 2025

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.

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.
@oxzi oxzi added the area/documentation End-user or developer help label Jan 24, 2025
@oxzi oxzi requested a review from Al2Klimov January 24, 2025 10:56
@cla-bot cla-bot bot added the cla/signed label Jan 24, 2025
Comment on lines -179 to +167
chapter. This CLI command is available since v2.8.
chapter.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What's this for?

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.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is very nice...

Comment on lines -255 to +245
$ icinga2 console
Icinga 2 (version: v2.11.0)
# icinga2 console
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

... but then you shouldn't have to be root. 😅

@@ -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
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

But AFAIK on Windows they're invisible to others, aren't they?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/documentation End-user or developer help cla/signed
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants