Internal Name:

Apache HTTP Server

Description:

an Apache HTTP Server instance

Singleton:

no

Plugin:

Apache

HttpdOnUnix

process|basename|match=httpd.*,process|basename|nomatch|parent=httpd.*

HttpdOnWindows

process|basename|match=(?i)httpd.exe,process|basename|match|parent=(?i)httpd.exe

Apache2OnUnix

process|basename|match=apache2,process|basename|nomatch|parent=apache2

ApacheOnWindows

process|basename|match=(?i)Apache.exe,process|basename|match|parent=(?i)Apache.exe

Enable augeas support

Enable augeas support

yes

augeasEnabled

Augeas Module Name

the name of the Augeas module/lens to use for loading and updating this resource's configuration

yes

augeasModuleName

Httpd config file

Location of the Apache main configuration file.

yes

configurationFilesInclusionPatterns

Virtual Hosts Configuration Placement

How should the new virtual host definitions be put in the configuration

yes

vhostCreationPolicy

Path To Contain Virtual Hosts Files

If the new virtual hosts should be created in standalone files, this mask determines where
to create those files. The '*' in the path is replaced by the name of the virtual host.
If the path is relative, it is considered relative to server root.

yes

vhostFilesMask

Error Log File Path

The absolute path to the error log file - if the path is not absolute, it will be resolved relative to the server root directory; if unset, default will be 'logs/error_log' on UNIX or 'logs\error.log' on Windows.

no

errorLogFilePath

Error Log Events Enabled

A flag indicating whether or not generation of Events for new error log entries is enabled.

yes

errorLogEventsEnabled

Error Log Minimum Severity

The minimum severity of error log entry Events that should be collected. If not specified, there is no minimum severity (i.e. all events will be collected).

no

errorLogMinimumSeverity

Error Log Includes Pattern

A regular expression against which an error log entry's detail is matched to determine if an Event should be fired for that entry. If not specified, no filtering of log entries will be done based on their detail.

no

errorLogIncludesPattern

Custom Module Names

Apache can use 2 values to identify a module. Either its module name that is used in the LoadModule directive
or its source file that can be used in the IfModule directive (as of Apache 2.1 the IfModule directive can but doesn't have to
use the module name, too).

Server Root

the absolute path of the Apache server root directory

yes

serverRoot

Executable Path

the path to the Apache executable - if the path is not absolute, it will be resolved relative to the server root directory; if unset, default value is 'bin/httpd' on UNIX or 'bin\Apache.exe' on Windows

no

executablePath

Control Script Path

the path to the Apache control script - if the path is not absolute, it will be resolved relative to the server root directory; if unset, default will be 'bin/apachectl' on UNIX or the Apache executable on Windows

no

controlScriptPath

Config File

the path to the httpd.conf file - if the path is not absolute, it will be resolved relative to the server root directory; if unset, default will be 'conf/httpd.conf' on UNIX

yes

configFile

URL

The http or https URL that will be used to check availability for this Apache server; if not set, availability will be determined based on whether plugin can connect to the Apache server's SNMP agent. Note that SSL certificate validation is disabled during availability checks if this is an HTTPS URL.

no

url

SNMP Agent Host

the host name or IP address of the Apache SNMP agent (typically '127.0.0.1')

yes

snmpAgentHost

SNMP Agent Port

the UDP port of the Apache SNMP agent (typically '1610')

yes

snmpAgentPort

SNMP Agent Community

the SNMP community of the Apache SNMP agent (typically 'public')

yes

snmpAgentCommunity

SNMP Request Timeout

the timeout, in milliseconds, for requests to the Apache SNMP agent; defaults to 2000

no

snmpRequestTimeout

SNMP Request Retries

the number of times a request that has timed out should be retried; defaults to 1

no

snmpRequestRetries

Restart After Configuration Update

If set to true, each configuration update of the server or any underlying virtual host or
directory is followed by the restart of the Apache instance so that the configuration changes
are applied immediately. If set to false, you have to manually restart the server (for example
using the restart operation in the operations tab) once all the configuration updates are finished.

yes

restartAfterConfigurationUpdate

Number of Concurrent Connections

measurement

Number of Concurrent Connections

applInboundAssociations

Server Built

trait

the date and time this Apache server's binary was compiled

serverBuilt

Start Time

trait

the date and time this Apache server was last started

wwwServiceStartTime

Time to ping the server for availability

measurement

Time it took to ping the server for availability over http; this includes DNS lookup time.

rhq_avail_ping_time

Listen

yes

Listen

Name Virtual Host

A required directive if you want to configure name-based virtual hosts.
Although the value can be hostname it is recommended that you always use an IP address.
IPv6 addresses must be enclosed in square brackets.
To receive requests on all interfaces, you can set the value to *.
Note that the IP address of a name-based virtual host must exactly match the value of this property.
The address may be optionally followed by the port specification to further limit the directive effect.

no

NameVirtualHost

Start

Starts this Apache server, or returns an error if it is already running. The control script used is specified in the Connection Properties.

Stop

Stops this Apache server, or returns an error if it is not running. The control script used is specified in the Connection Properties.

Restart

Restarts the Apache server by sending its process a SIGHUP. If the server is not running, it is started. This command automatically checks the server's configuration files via configtest before initiating the restart to make sure Apache doesn't die. The control script used is specified in the Connection Properties. Only supported on UNIX platforms.

Start with SSL Support

Starts this Apache server with support for SSL. The control script used is specified in the Connection Properties. Only supported on Apache 1.3.

Restart Gracefully

Gracefully restarts the Apache server by sending it a SIGUSR1. If the daemon is not running, it is started. This differs from a normal restart in that currently open connections are not aborted. A side effect is that old log files will not be closed immediately. This means that if used in a log rotation script, a substantial delay may be necessary to ensure that the old log files are closed before processing them. This command automatically checks the configuration files via configtest before initiating the restart to make sure Apache doesn't die. The control script used is specified in the Connection Properties.

Check Configuration File Syntax

Run a configuration file syntax test. It parses the configuration files and either reports Syntax Ok or detailed information about the particular syntax error. The control script used is specified in the Connection Properties. Only supported on UNIX platforms.

Install mod_jk configuration

Tries to install a mod_jk configuration in httpd.conf if none is detected. This includes a workers.properties file and urimap file