Additional Commands for Config Scan Agent Configuration

Option Argument / Value Description
--version None Displays the Config Scan Agent version

Example: ./config-scan-agent --version
--license None Displays the license information for the Config Scan Agent

Example: ./config-scan-agent --license
--config CONFIG_FILE_PATH Specifies the location of the config file to be used for the scan.

Use the --secret-key parameter along with the --config parameter to specify the secret key for decrypting the config file.

Example: ./config-scan-agent --config /home/user/config.ini --secret-key /home/user/secret.key

--secret-key KEY_FILE_PATH Specifies the path to the secret key file used for decrypting an encrypted config file
--create-config None Creates a config file in the current directory

Also creates a secret key file in the same directory used for encryption/decryption of configuration file.

Example: ./config-scan-agent --create-config
--update-config CONFIG_FILE_PATH Interactively updates the configuration file at specified location

Use the --secret-key parameter with the --update-config to specify the key location for encryption/decryption of the configuration file.

Example: ./config-scan-agent --update-config /home/user/config.ini --secret-key /home/user/secret.key

--view-config CONFIG_FILE_PATH Displays the decrypted contents of the config file at the specified location

Use the --secret-key parameter with the --view-config to specify the key location for encryption/decryption of the configuration file.

Example: ./config-scan-agent --view-config /home/user/config.ini --secret-key /home/user/secret.key

--rotate-key EXISTING_KEY_FILE_PATH Rotates the secret key for the configuration file

Use the --config parameter with the --rotate-key to use the existing configuration file with the newly rotated key. The key will be rotated and stored in the same file specified.

Use --config parameter along with --rotate-key to use the existing configuration file with the newly rotated key. The key will be rotated and stored in the same file specified.

Example: ./config-scan-agent --config /home/user/config.ini --rotate-key /home/user/secret.key

--output OUTPUT_FOLDER_PATH Specifies the output directory where the scan results will be stored

Example: ./config-scan-agent --config /home/user/config.ini --secret-key /home/user/secret.key --output /home/user/output/

--log-dir LOG_FOLDER_PATH Specifies the directory path to store the log files generated during scan agent execution

Example: ./config-scan-agent --config /home/user/config.ini --secret-key /home/user/secret.key --log-dir /home/user/logs/

--log-level DEBUG, INFO, WARNING, ERROR, CRITICAL Sets the verbosity level of logging, letting you control how much information the application logs and/or displays

A lower verbosity level shows only critical errors, while higher levels include warnings, informational messages, and detailed debugging output. This helps users or developers adjust the amount of detail they see based on their troubleshooting or monitoring needs.

Default log level: INFO

Example: ./config-scan-agent --config /home/user/config.ini --secret-key /home/user/secret.key --log-level DEBUG

--log-retain NO_OF_LOGS Specifies the count of logs to be maintained in the log folder

Default value: 20

Example: ./config-scan-agent --config /home/user/config.ini --secret-key /home/user/secret.key --log-retain 30

--update-service-acc CONFIG_FILE_PATH Updates the service account credentials stored in the configuration file

Use the --config and --key parameters, along with the --update-service-account parameter to specify the configuration file and the key file locations.

Example: ./config-scan-agent --update-service-acc /home/user/config.ini --secret-key /home/user/secret.key

--schedule-upgrade NONE Schedules upgrade process for the agent

This will create a scheduled service that runs at specified intervals, and checks and auto-upgrades the agent if a newer version is available.

Use this parameter with the --config and the --secret-key parameters.

Example: ./config-scan-agent --schedule-upgrade --config /abs/path/to/config.ini --secret-key /abs/path/to/secret.key
--user USER_NAME To be used with the --schedule-upgrade parameter only

User authorized to run the scheduler service (default: root (linux), system (windows)), which checks and upgrades agents, if an upgrade is available, in specified intervals.

Example: ./config-scan-agent --schedule-upgrade --config /abs/path/to/config.ini --secret-key /abs/path/to/secret.key --user Administrator
--group GROUP_NAME To be used with the --schedule-upgrade parameter and for Linux machines only

User group authorized to run the systemd service (default: root), which checks and upgrades agents, if an upgrade is available, in specified intervals.

Example: ./config-scan-agent --schedule-upgrade --config /abs/path/to/config.ini --secret-key /abs/path/to/secret.key --group user_group
--interval INTERVAL_DURATION To be used with the --schedule-upgrade parameter only

Specifies the interval duration to check for upgrades

Examples of possible values: 6h, 2h, 24h, 36h, and so on

Default value: 6h

Example: ./config-scan-agent --schedule-upgrade --config /abs/path/to/config.ini --secret-key /abs/path/to/secret.key --interval 24h
--boot-delay DELAY_DURATION To be used with the --schedule-upgrade parameter only

Specifies the delay after the boot

Examples of possible values: 5min, 15min, and so on

Default value: 5min

Example: ./config-scan-agent --schedule-upgrade --config /abs/path/to/config.ini --secret-key /abs/path/to/secret.key --boot-delay 10min