Internal Name:

Apache Virtual Host

Description:

Singleton:

no

Plugin:

Apache

Response Time Log File

the full path to the log file containing response-time stats for this virtual host

no

responseTimeLogFile

Response Time Url Excludes

a space-delimited list of regular expressions specifying URLs that should be excluded from response-time stats collection

no

responseTimeUrlExcludes

Response Time Url Transforms

a space-delimited list of Perl-style substitution expressions that should be applied to all URLs for which response-time stats are collected (e.g. |^/dept/finance/.*|/dept/finance/*|)

no

responseTimeUrlTransforms

URL

The http or https URL that will be used to check availability for this virtual host. Note that SSL certificate validation is disabled during availability checks if this is an HTTPS URL. If the URL is not set, the availability is determined by pinging the configured SNMP location.

no

url

Host

trait

the host name or IP address of this virtual host

wwwServiceName

Port

trait

the TCP port of this virtual host

wwwServiceProtocol

Administrator

trait

the administrator of this virtual host

wwwServiceContact

Total Number of Requests

measurement

The number of inbound requests on the service

wwwSummaryInRequests

Total Number of Requests per Minute

measurement

The number of inbound requests on the service

wwwSummaryInRequests

Total Number of Bytes Received

measurement

The number of bytes received by the service

wwwSummaryInLowBytes

Total Number of Bytes Received per Minute

measurement

The number of bytes received by the service

wwwSummaryInLowBytes

Total Number of Responses

measurement

The number of outbound requests on the service

wwwSummaryOutResponses

Total Number of Responses per Minute

measurement

The number of outbound requests on the service

wwwSummaryOutResponses

Total Number of Bytes Sent

measurement

The number of bytes sent by the service

wwwSummaryOutLowBytes

Total Number of Bytes Sent per Minute

measurement

The number of bytes sent by the service

wwwSummaryOutLowBytes

Number of GET Requests

measurement

The number of inbound GET requests on the service

wwwRequestInRequests.GET

Number of GET Requests per Minute

measurement

The number of inbound GET requests on the service

wwwRequestInRequests.GET

Number of HEAD Requests

measurement

The number of inbound HEAD requests on the service

wwwRequestInRequests.HEAD

Number of HEAD Requests per Minute

measurement

The number of inbound HEAD requests on the service

wwwRequestInRequests.HEAD

Number of POST Requests

measurement

The number of inbound POST requests on the service

wwwRequestInRequests.POST

Number of POST Requests per Minute

measurement

The number of inbound POST requests on the service

wwwRequestInRequests.POST

Number of PUT Requests

measurement

The number of inbound PUT requests on the service

wwwRequestInRequests.PUT

Number of PUT Requests per Minute

measurement

The number of inbound PUT requests on the service

wwwRequestInRequests.PUT

Bytes Received for GET Requests

measurement

The number of bytes received by GET requests on the service

wwwRequestInBytes.GET

Bytes Received for GET Requests per Minute

measurement

The number of bytes received by GET requests on the service

wwwRequestInBytes.GET

Bytes Received for HEAD Requests

measurement

The number of bytes received by HEAD requests on the service

wwwRequestInBytes.HEAD

Bytes Received for HEAD Requests per Minute

measurement

The number of bytes received by HEAD requests on the service

wwwRequestInBytes.HEAD

Bytes Received for POST Requests

measurement

The number of bytes received by POST requests on the service

wwwRequestInBytes.POST

Bytes Received for POST Requests per Minute

measurement

The number of bytes received by POST requests on the service

wwwRequestInBytes.POST

Bytes Received for PUT Requests

measurement

The number of bytes received by PUT requests on the service

wwwRequestInBytes.PUT

Bytes Received for PUT Requests per Minute

measurement

The number of bytes received by PUT requests on the service

wwwRequestInBytes.PUT

Number of 200 Responses

measurement

The number of 200 responses generated by this service

wwwResponseOutResponses.200

Number of 200 Responses per Minute

measurement

The number of 200 responses generated by this service

wwwResponseOutResponses.200

Number of 301 Responses

measurement

The number of 301 responses generated by this service

wwwResponseOutResponses.301

Number of 301 Responses per Minute

measurement

The number of 301 responses generated by this service

wwwResponseOutResponses.301

Number of 302 Responses

measurement

The number of 302 responses generated by this service

wwwResponseOutResponses.302

Number of 302 Responses per Minute

measurement

The number of 302 responses generated by this service

wwwResponseOutResponses.302

Number of 401 Responses

measurement

The number of 401 responses generated by this service

wwwResponseOutResponses.401

Number of 401 Responses per Minute

measurement

The number of 401 responses generated by this service

wwwResponseOutResponses.401

Number of 403 Responses

measurement

The number of 403 responses generated by this service

wwwResponseOutResponses.403

Number of 403 Responses per Minute

measurement

The number of 403 responses generated by this service

wwwResponseOutResponses.403

Number of 404 Responses

measurement

The number of 404 responses generated by this service

wwwResponseOutResponses.404

Number of 404 Responses per Minute

measurement

The number of 404 responses generated by this service

wwwResponseOutResponses.404

Number of 500 Responses

measurement

The number of 500 responses generated by this service

wwwResponseOutResponses.500

Number of 500 Responses per Minute

measurement

The number of 500 responses generated by this service

wwwResponseOutResponses.500

Bytes Sent for 200 Responses

measurement

The number of bytes sent for 200 responses generated by this service

wwwResponseOutBytes.200

Bytes Sent for 200 Responses per Minute

measurement

The number of bytes sent for 200 responses generated by this service

wwwResponseOutBytes.200

Bytes Sent for 301 Responses

measurement

The number of bytes sent for 301 responses generated by this service

wwwResponseOutBytes.301

Bytes Sent for 301 Responses per Minute

measurement

The number of bytes sent for 301 responses generated by this service

wwwResponseOutBytes.301

Bytes Sent for 302 Responses

measurement

The number of bytes sent for 302 responses generated by this service

wwwResponseOutBytes.302

Bytes Sent for 302 Responses per Minute

measurement

The number of bytes sent for 302 responses generated by this service

wwwResponseOutBytes.302

Bytes Sent for 401 Responses

measurement

The number of bytes sent for 401 responses generated by this service

wwwResponseOutBytes.401

Bytes Sent for 401 Responses per Minute

measurement

The number of bytes sent for 401 responses generated by this service

wwwResponseOutBytes.401

Bytes Sent for 403 Responses

measurement

The number of bytes sent for 403 responses generated by this service

wwwResponseOutBytes.403

Bytes Sent for 403 Responses per Minute

measurement

The number of bytes sent for 403 responses generated by this service

wwwResponseOutBytes.403

Bytes Sent for 404 Responses

measurement

The number of bytes sent for 404 responses generated by this service

wwwResponseOutBytes.404

Bytes Sent for 404 Responses per Minute

measurement

The number of bytes sent for 404 responses generated by this service

wwwResponseOutBytes.404

Bytes Sent for 500 Responses

measurement

The number of bytes sent for 500 responses generated by this service

wwwResponseOutBytes.500

Bytes Sent for 500 Responses per Minute

measurement

The number of bytes sent for 500 responses generated by this service

wwwResponseOutBytes.500

HTTP Response Time

calltime

The minimum, maximum, and average response times for HTTP requests serviced by this virtual host

ResponseTime

Error Log

Sets the name of the file to which the server will log any errors it encounters. If the file-path is not absolute then it is assumed to be relative to the ServerRoot.
If the file-path begins with a pipe (|) then it is assumed to be a command to spawn to handle the error log.
Using syslog instead of a filename enables logging via syslogd(8) if the system supports it. The default is to use syslog facility local7, but you can override this by using the syslog:facility syntax where facility can be one of the names usually documented in syslog(1).

no

ErrorLog

Request logs

Configure the logging of requests to the server.

yes

CustomLog

Server Name

Sets the request scheme, hostname and port that the server uses to identify itself. This is used when creating redirection URLs.
If no ServerName is specified, then the server attempts to deduce the hostname by performing a reverse lookup on the IP address. If no port is specified in the ServerName, then the server will use the port from the incoming request. For optimal reliability and predictability, you should specify an explicit hostname and port using the ServerName directive.
If you are using name-based virtual hosts, the ServerName inside a <VirtualHost> section specifies what hostname must appear in the request's Host: header to match this virtual host.

no

ServerName

Server Alias

yes

ServerAlias

Server Admin

The email address or URL to contact the server administrator in case of errors. This address is used in various Apache generated error messages.

no

ServerAdmin

Document Root

This directive sets the directory from which httpd will serve files. Unless matched by a directive like Alias, the server appends the path from the requested URL to the document root to make the path to the document.
If the directory-path is not absolute then it is assumed to be relative to the ServerRoot.
The DocumentRoot should be specified without a trailing slash.

yes

DocumentRoot

Add Default Charset

This directive specifies a default value for the media type charset parameter (the name of a character encoding) to be added to a response if and only if the response's content-type is either text/plain or text/html.
Value "Off" disables this functionality. "On" enables a default charset of iso-8859-1. Any other value is assumed to be the charset to be used, which should be one of the IANA registered charset values for use in MIME media types.

no

AddDefaultCharset

Alias

The Alias directive allows documents to be stored in the local filesystem other than under the DocumentRoot.
With " Alias /image /ftp/pub/image", a request for http://myserver/image/foo.gif

would cause the server to return the file /ftp/pub/image/foo.gif. Only complete path segments are matched, so the above alias would not match a request for http://myserver/imagefoo.gif

.
Note that you may need to specify additional <Directory> sections which cover the destination of aliases.
In particular, if you are creating an Alias to a directory outside of your DocumentRoot, you may need to explicitly permit access to the target directory.

yes

Alias

Default Type

There will be times when the server is asked to provide a document whose type cannot be determined by its MIME types mappings.
The server SHOULD inform the client of the content-type of the document. If the server is unable to determine this by normal means, it will set it to the configured DefaultType.

no

DefaultType

Directory Index

Sets the list of resources to look for, when the client requests an index of the directory by specifying a / at the end of the directory name.
Note that the documents do not need to be relative to the directory.

no

DirectoryIndex

Error Document

In the event of a problem or error, Apache can be configured to do one of four things,
1. output a simple hardcoded error message,
2. output a customized message,
3. redirect to a local URL-path to handle the problem/error,
4. redirect to an external URL to handle the problem/error.
The first option is the default, while options 2-4 are configured using the ErrorDocument directive, which is followed by the HTTP response code and a URL or a message. Apache will sometimes offer additional information regarding the problem/error.

yes

ErrorDocument

Timeout

The TimeOut directive defines the length of time Apache will wait for I/O in various circumstances.

no

Timeout

Options

The Options directive controls which server features are available in a particular directory.

no

Options

Use Canonical Name

With UseCanonicalName On Apache will use the hostname and port specified in the ServerName directive to construct the canonical name for the server. This name is used in all self-referential URLs, and for the values of SERVER_NAME and SERVER_PORT in CGIs.
With UseCanonicalName Off Apache will form self-referential URLs using the hostname and port supplied by the client if any are supplied (otherwise it will use the canonical name, as defined above).
UseCanonicalName DNS is intended for use with mass IP-based virtual hosting to support ancient clients that do not provide a Host: header. With this option Apache does a reverse DNS lookup on the server IP address that the client connected to in order to work out self-referential URLs.

no

UseCanonicalName

Use Canonical Physical Port

In many situations Apache must construct a self-referential URL -- that is, a URL that refers back to the same server. With UseCanonicalPhysicalPort On Apache will, when constructing the canonical port for the server to honor the UseCanonicalName directive, provide the actual physical port number being used by this request as a potential port. With UseCanonicalPhysicalPort Off Apache will not ever use the actual physical port number, instead relying on all configured information to construct a valid port number.

no

UseCanonicalPhysicalPort