Command Line Options

ActivationId

A valid activation key ID (UUID). This value is obtained from the Cloud Agent UI (go to Activation Keys, select a key then View Key Info). This parameter is required to provision an agent.

CustomerId

A valid customer ID (UUID). This value is obtained from the Cloud Agent UI (go to Activation Keys, select a key then Install Agent). This parameter is required to provision an agent.

LogLevel

A log level (0-5). A higher value corresponds to more verbosity. The default is, mapped to information (3).

0 - mapped to fatal

1 - mapped to error

2 - mapped to warning

3 - mapped to information

4 - mapped to debug

5 - mapped to trace

In a debug/trace mode, the log file may contain sensitive command-line parameters or passwords for configuration files if the passwords are in clear-text format. Storing passwords in configuration files can result in non-compliance with ISO, SOC, PCI-DSS, HIPAA, and FedRAMP guidelines.

Qualys recommends using a password vault or token-based authentication instead of storing passwords in the configuration file. 

LogFileDir

A full path to the log file. By default, the path is /var/log/qualys/.

UseSudo

Set to 1 to run all data collection commands using the sudo escalation method. By default, sudo is not used (0).

SudoCommand

A command for privilege escalation such as SudoCommand pbrun. If the command has spaces, it must be double-quoted.

User

A valid username is required if you want the daemon to run as a certain user. The daemon starts as root but later drops to the specified user and continues running as that user.

Group

A valid group name if you want the daemon to run as a certain group. The daemon switches to the specified group (if any).

HostIdSearchDir

(Available using Linux Agent 1.3.3 and later) The directory where the host ID file is located. This file contains a host ID tag assigned to the system by Qualys. By default, the directory is /etc/, and the location of the host ID file is /etc/qualys/hostid.

LogDestType

(Available using Linux Agent 1.3.3 and later) The destination of log lines generated by Linux Agent. Set this to file or syslog. If set to file, specify the location of the log file. By default, the destination of a log file is:

/var/log/qualys/qualys-cloud-agent.log

ServerUri

Use this option to migrate the agent from one Qualys subscription to another (on the same POD or PCP).

ServerUri takes the URL of the Qualys shared Pod or PCP you want to migrate the Cloud Agent, in the following format:

ServerUri=<http_url>/CloudAgent

where <http_url> is the URL of the Qualys shared Pod or PCP.

If the subscription is on the same POD, the ServerUri is the same.

Use this option along with ActivationId and CustomerId in order to move the agent to another Qualys shared POD or PCP.

The Cloud Agent requires the appropriate Activation ID and Customer ID for the new subscription/platform. The original IDs cannot be used as they are unique per subscription.

CmdMaxTimeOut

Execution of a command is dropped if the time taken to execute is more than the specified value. The default timeout is 1800 seconds (30 minutes).

ProcessPriority

Specify the Linux niceness scale between -20 and 19 to set a priority for the Qualys cloud agent process. The lower the number, the higher the priority the agent process gets. The default value is zero.