You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
The Wazuh agent CLI needs enhancements to improve the registration process and provide clearer help documentation. Additionally, options should be displayed only for the relevant operating system.
If --connect-url is provided, the wazuh-agent.yml file should be updated with the specified URL, for example:
server_url: https://192.168.100.121:27000
Improve --help output
Currently, the help command output for registration is:
.\wazuh-agent.exe --register-agent --help
--url, --user and --password args are mandatory
Expected behavior:
Display all available options for --register-agent with descriptions.
Ensure clarity on mandatory and optional parameters.
Filter OS-specific options
Currently, some CLI options not applicable to the running OS are displayed. For example, on Windows, these options should only be shown when applicable:
--install-service Use this option to install Wazuh as a Windows service
--remove-service Use this option to remove Wazuh Windows service
--run-service Use this option to run Wazuh as a Windows service
Expected behavior:
Only show OS-relevant options when using --help.
Definition of Done
The new --enroll-agent command is implemented.
The --help output is updated with full descriptions.
OS-specific options are correctly filtered.
Tests validate all changes.
Documentation is updated accordingly.
The text was updated successfully, but these errors were encountered:
Description
The Wazuh agent CLI needs enhancements to improve the registration process and provide clearer help documentation. Additionally, options should be displayed only for the relevant operating system.
Requirements
Update agent registration command
Currently, the agent registration command is:
.\wazuh-agent.exe --register-agent --user wazuh --password wazuh --url https://192.168.100.121:55000 --verification-mode none
The new command should looks like:
.\wazuh-agent.exe --enroll-agent --user wazuh --password wazuh --enroll-url https://192.168.100.121:55000 --connect-url https://192.168.100.121:27000 --verification-mode none
--enroll-url
→ MANDATORY--connect-url
→ OPTIONALIf
--connect-url
is provided, thewazuh-agent.yml
file should be updated with the specified URL, for example:Improve
--help
outputCurrently, the help command output for registration is:
.\wazuh-agent.exe --register-agent --help --url, --user and --password args are mandatory
Expected behavior:
--register-agent
with descriptions.Filter OS-specific options
Currently, some CLI options not applicable to the running OS are displayed. For example, on Windows, these options should only be shown when applicable:
Expected behavior:
--help
.Definition of Done
--enroll-agent
command is implemented.--help
output is updated with full descriptions.The text was updated successfully, but these errors were encountered: