|Oracle® Traffic Director Configuration File Reference
11g Release 1 (22.214.171.124)
Part Number E21038-03
|PDF · Mobi · ePub|
server.xml file contains most of the server configuration. This chapter describes the basic syntax of the
server.xml file and provides a high-level view of the elements that are used to configure features of the server. This chapter contains the following topics:
The encoding is UTF-8 to maintain compatibility with UNIX text editors.
In general, you do not need to edit
server.xml directly. Instead, use the Administrator Console and the
tadm command-line interface to change values in the
server.xml file. The changes that are made using the Administrator Console and
tadm command-line interface affects the
server.xml file. Using
tadm when creating scripts to change the
server.xml file ensures forward compatibility. If you edit the
server.xml file directly, ensure that the resulting
server.xml file is valid.
To change the values in the
server.xml file, change the value between the tags associated with the element you are editing. For example, to change the value of
TRACE:1, find the
log child element of the
server element. In this example, you see the following lines:
<log> <log-file>../logs/server.log</log-file> <log-level>NOTIFICATION:1</log-level> </log>
Changing the log-level from
TRACE:1 is shown below:
After you make changes to the
server.xml file, you must deploy your configuration for most changes to take effect. Use the command-line interface command
tadm pull-config to pull the modified
server.xml file, then use the Administrator Console or the
tadm deploy-config command to deploy your changes. For some changes, you must restart the server before they take effect. For information about changes that require a restart and which do not, see Section 1.3, "Dynamic Reconfiguration".
To add a new element to the file, add the element and any required subelements. Elements begin with a tag, for example
<virtual-server>, and end with the closing tag, for example
</virtual-server>. The tags are case-sensitive.
You can also use the
-configtest option of the
startserv script to validate your configuration. From the instance's
bin directory, run:
To change the
server.xml file for your environment, you must know which elements contain the relevant settings. The following sections contain brief descriptions of the elements that configure the functional areas:
For more information about all the
server.xml elements and their subelements, see Elements in server.xml.
origin-server element defines a member of a server pool. The
origin-server-pool element configures a pool of origin servers that are used for load balancing requests. An origin server is a back-end server—such as an Oracle WebLogic Server instance or an Oracle iPlanet Web Server instance—to which Oracle Traffic Director should forward requests that it receives from clients, and from which it receives responses. A set of origin servers providing the same service constitute an origin server pool. For more information, see Section 3.1.15, "origin-server-pool", Section 3.1.16, "origin-server", Section 3.1.22, "server"
health-check element configures the parameters that are used to determine the status of each origin server in an origin-server pool. The
health-check element is a subelement of the
origin-server-pool element. For more information, see Section 3.1.8, "health-check" and Section 3.1.15, "origin-server-pool"
failover-group element is a grouping of a VIP (Virtual IP), an instance that is designated as the primary server and another instance designated as the backup server. The Active-Passive or Active-Active cluster failover configurations are represented as Failover Groups. The
failover-group element defines a failover group. For more information, see Section 3.1.7, "failover-group"
http element configures the general HTTP protocol options. The
keep-alive element configures the HTTP keep-alive connection management. The
http-listener element configures the ports and IP addresses on which the server listens for new HTTP connections. The
virtual-server element configures a method by which the server processes the HTTP requests. For more information, see Section 3.1.9, "http", Section 3.1.12, "keep-alive", Section 3.1.10, "http-listener", and Section 3.1.36, "virtual-server".
access-log element configures the file name and format of access logs. The
access-log-buffer element configures the frequency of access log updates and ordering of the access log entries. For more information, see Section 3.1.1, "access-log" and Section 3.1.2, "access-log-buffer". For more information about the log file format, see Appendix B, "Using the Custom Access-Log File Format".
log element configures the file name and contents of the server log. The
event element configures the access log and server log rotation. For more information, see Section 3.1.14, "log" and Section 3.1.6, "event".
snmp element configures Simple Network Management Protocol (SNMP), and the
stats element configures statistics collection. For more information, see Section 3.1.23, "snmp" and Section 3.1.27, "stats".
thread-pool element configures the number of threads used to process requests and the maximum number of HTTP connections that the server queues. For more information, see Section 3.1.32, "thread-pool".
keep-alive element configures the HTTP keep-alive connection management. For more information, see Section 3.1.12, "keep-alive". The
dns-cache element configures the DNS caching. For more information, see Section 3.1.5, "dns-cache".
ssl element configures Secure Sockets Layer (SSL) and Transport Layer Security (TLS). SSL and TLS can be configured separately for each HTTP listener. For more information, see Section 3.1.24, "ssl" and Section 3.1.10, "http-listener".
pkcs11 element configures the PKCS #11 subsystem, including certificate revocation lists (CRLs) and third-party cryptographic modules. For more information, see Section 3.1.17, "pkcs11".
variable element defines a variable for use in expressions, log formats, and
obj.conf parameters. For more information about the
variable element, see Section 3.1.35, "variable". For more information about variable and expression use, see Appendix A, "Using Variables, Expressions, Wildcards, and String Interpolation".
virtual-server element configures the virtual servers. Each virtual server processes HTTP requests from one or more HTTP listeners. The
http-listener element configures the HTTP listeners. For more information, see Section 3.1.36, "virtual-server", and Section 3.1.10, "http-listener".
You can define variables within a virtual server using the
variable element, as described in Section 2.2.8, "Variables".
<?xml version="1.0" encoding="UTF-8" ?> <!-- Copyright (c) 2011, Oracle and/or its affiliates. All rights reserved --> <server> <cluster> <local-host>www.example.com</local-host> <instance> <host>www.example.com</host> </instance> </cluster> <log> <log-file>../logs/server.log</log-file> <log-level>NOTIFICATION:1</log-level> </log> <platform>64</platform> <temp-path>/tmp/net-test-8a4af444</temp-path> <user>myuser</user> <access-log> <file>../logs/access.log</file> </access-log> <http-listener> <name>http-listener-1</name> <port>1894</port> <server-name>www.example.com</server-name> <default-virtual-server-name>test</default-virtual-server-name> </http-listener> <virtual-server> <name>test</name> <http-listener-name>http-listener-1</http-listener-name> <host>www.example.com</host> <object-file>test-obj.conf</object-file> </virtual-server> <origin-server-pool> <name>origin-server-pool-1</name> <type>http</type> <origin-server> <host>www.example.com</host> <port>20005</port> </origin-server> </origin-server-pool> </server>