Skip to content

Latest commit

 

History

History
316 lines (183 loc) · 10 KB

REFERENCE.md

File metadata and controls

316 lines (183 loc) · 10 KB
Raw

Reference

Table of Contents

Classes

Classes

qualys_agent

Manage an installation of the Qualys Cloud Agent

Examples

class { 'qualys_agent':
  activation_id => 'XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX',
  customer_id   => 'XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX',
}

Parameters

The following parameters are available in the qualys_agent class:

ensure

Data type: Enum['absent', 'present']

Ensure that the Qualys agent is present on the system, or absent.

activation_id

Data type: Variant[String[1], Sensitive[String[1]]]

The Activation ID you receive from Qualys for reporting back to their API (required)

agent_group

Data type: Optional[String]

The group that should run the agent. This also will be the UserGroup setting in the configuration file. (Default: undef)

agent_user

Data type: Optional[String]

The user that should run the agent (Default: undef)

agent_user_homedir

Data type: Stdlib::Absolutepath

The fully qualified path to the agent user's home directory (Default: /usr/local/qualys)

cmd_max_timeout

Data type: Integer

The CmdMaxTimeOut value in qualys-cloud-agent.conf (Default: 1800)

cmd_stdout_size

Data type: Integer

The CmdStdOutSize value in qualys-cloud-agent.conf (Default: 1024)

conf_dir

Data type: Stdlib::Absolutepath

The directory where the qualys-cloud-agent.conf file will exist (Default: /etc/qualys/cloud-agent)

customer_id

Data type: Variant[String[1], Sensitive[String[1]]]

The Customer ID you receive from Qualys for reporting back to their API (required)

env_dir

Data type: Stdlib::Absolutepath

The directory in which to place the environment variable file qualys-cloud-agent. (Default: /etc/sysconfig)

hostid_path

Data type: Stdlib::Absolutepath

The full filesystem path to the hostid file (Default: /etc/qualys/hostid)

hostid_search_dir

Data type: Optional[Stdlib::Absolutepath]

The HostIdSearchDir value in qualys-cloud-agent.conf (Default: undef)

https_proxy

Data type: Optional[String]

The https proxy to be used for all commands performed by the Cloud Agent. (Default: undef)

log_dest_type

Data type: Enum['file', 'syslog']

The log type (file or syslog) (Default: file)

log_file_dir

Data type: Stdlib::Absolutepath

The LogFileDir value in qualys-cloud-agent.conf The directory in which the log files should be written (Default: /var/log/qualys)

log_group

Data type: Optional[String]

The group that should own files in the log directory (Default: $agent_group)

log_level

Data type: Integer

The LogLevel value in qualys-cloud-agent.conf (Default: 3)

log_mode

Data type: String

The file mode for log files in $log_file_dir (Default: 0600)

log_owner

Data type: Optional[String]

The user that should own files in the log directory (Default: $agent_user)

manage_group

Data type: Boolean

Boolean to determine whether the group is managed by Puppet or not (Default: true)

manage_package

Data type: Boolean

Boolean to determine whether the package is managed by Puppet or not (Default: true)

manage_service

Data type: Boolean

Boolean to determine whether the service is managed by Puppet or not (Default: true)

manage_user

Data type: Boolean

Boolean to determine whether the user is managed by Puppet or not (Default: true)

package_ensure

Data type: String

The "ensure" value for the Qualys agent package. This value can be "installed", "absent", or a version number if you want to specify a specific package version numer. (Default: installed)

package_name

Data type: String

The name of the package to install (Default: qualys-cloud-agent)

process_priority

Data type: Integer

The ProcessPriority value in qualys-cloud-agent.conf (Default: 0)

qualys_https_proxy

Data type: Optional[String]

The https proxy to be used by the Cloud Agent to communicate with qualys cloud platform. (Default: undef)

request_timeout

Data type: Integer

The RequestTimeOut value in qualys-cloud-agent.conf (Default: 600)

service_enable

Data type: Boolean

Boolean to determine whether the service is enabled or not (Default: true)

service_ensure

Data type: Enum['running', 'stopped']

Ensure that the Qualys agent is running on the system, or stopped (Default: running)

service_name

Data type: String

The name of the Qualys agent service (Default: qualys-cloud-agent)

sudo_command

Data type: String

The SudoCommand value in qualys-cloud-agent.conf (Default: sudo)

sudo_user

Data type: String

The SudoUser value in qualys-cloud-agent.conf (Default: undef)

use_audit_dispatcher

Data type: Integer

The UseAuditDispatcher value in qualys-cloud-agent.conf (Default: 1)

use_sudo

Data type: Integer

The UseSudo value in qualys-cloud-agent.conf (Default: 0)

webservice_uri

Data type: Optional[String]

The ServerUri value in qualys-cloud-agent.conf (Default: undef)

qualys_agent::config

Manage the main qualys-cloud-agent.conf configuration file. This class also includes the qagent_log and qagent_udc_log subclasses to configure both log configuration files.

qualys_agent::config::qagent_log

Manage the main qagent-log.conf configuration file

qualys_agent::config::qagent_udc_log

Manage the main qagent-udc-log.conf configuration file

qualys_agent::package

Install or uninstall the Qualys agent package

qualys_agent::service

Manage the system service that runs the Qualys agent

qualys_agent::user

Manage the system user and group that run the Qualys agent