Go to main content
1/12
Contents
Title and Copyright Information
Preface
Audience
Documentation Accessibility
Related Documents
Conventions
1
Overview of Configuration Files and Directories
1.1
Configuration Files
1.1.1
The server.xml File
1.1.2
The obj.conf File
1.1.3
The certmap.conf File
1.1.3.1
Syntax
1.1.3.2
Properties
1.1.4
NZ Wallet Files
1.1.5
Default Paths
1.2
Directory Structure
1.2.1
bin
1.2.2
Legal
1.2.3
lib
1.2.4
admin-server
1.2.5
net-server-id
1.3
Dynamic Reconfiguration
2
Syntax and Use of server.xml
2.1
Overview of server.xml
2.1.1
Editing the server.xml File
2.1.1.1
Editing Element Values
2.1.1.2
Adding Elements
2.1.1.3
Validating server.xml
2.2
Understanding server.xml
2.2.1
Server Pools
2.2.2
Health check
2.2.3
High Availability
2.2.4
HTTP Protocol
2.2.5
Logging and Monitoring
2.2.6
Performance Tuning
2.2.7
SSL, TLS, and PKCS #11
2.2.8
Variables
2.2.9
Virtual Servers
2.3
Sample server.xml File
3
Elements in server.xml
3.1
List of Elements
3.1.1
access-log
3.1.2
access-log-buffer
3.1.3
cluster
3.1.4
cert
3.1.5
crl
3.1.6
cipher
3.1.7
dns
3.1.8
dns-cache
3.1.9
event
3.1.10
event-subscription
3.1.11
failover-group
3.1.12
ftp-filter
3.1.13
health-check
3.1.14
http
3.1.15
http-listener
3.1.16
instance
3.1.17
keep-alive
3.1.18
localization
3.1.19
log
3.1.20
max-fd
3.1.21
origin-server-pool
3.1.22
origin-server
3.1.23
property
3.1.24
proxy-cache
3.1.25
qos-limits
3.1.26
server
3.1.27
snmp
3.1.28
ssl
3.1.29
ssl3-tls-ciphers
3.1.30
ssl-session-cache
3.1.31
stats
3.1.32
status-listener
3.1.33
tcp-access-log
3.1.34
tcp-listener
3.1.35
tcp-proxy
3.1.36
tcp-thread-pool
3.1.37
thread-pool
3.1.38
time
3.1.39
variable
3.1.40
virtual-server
3.1.41
webapp-firewall-ruleset
4
Syntax and Use of obj.conf
4.1
Request-Handling Process Overview
4.1.1
Steps in the Request-Handling Process
4.2
Directives in obj.conf
4.3
Objects in obj.conf
4.3.1
Objects That Use the name Attribute
4.3.2
Objects That Use the ppath Attribute
4.3.3
Using the Client, If, ElseIf, and Else Tags
4.3.3.1
Client
4.3.3.2
If, ElseIf, and Else
4.4
Flow of Control in obj.conf
4.4.1
AuthTrans
4.4.2
NameTrans
4.4.2.1
How and When Oracle Traffic Director Processes Other Objects
4.4.3
PathCheck
4.4.4
ObjectType
4.4.5
Input
4.4.6
Output
4.4.7
Route
4.4.8
Service
4.4.9
AddLog
4.4.10
Error
4.5
Changes in Function Flow
4.5.1
Restarted Requests
4.5.2
Internal Requests
4.5.3
URI Translation
4.6
Editing obj.conf
4.6.1
Order of Directives
4.6.2
Parameters
4.6.3
Case Sensitivity
4.6.4
Separators
4.6.5
Quotation Marks
4.6.6
Spaces
4.6.7
Line Continuation
4.6.8
Path Names
4.6.9
Comments
5
Predefined Server Application Functions and Filters in obj.conf
5.1
The bucket Parameter
5.2
AuthTrans
5.2.1
get-sslid
5.2.2
qos-handler
5.2.3
webapp-firewall
5.3
NameTrans
5.3.1
assign-name
5.3.2
block-request-cookie
5.3.3
map
5.3.4
reverse-map
5.3.5
rewrite
5.3.6
sed-request-header
5.3.7
strip-params
5.4
PathCheck
5.4.1
check-request-limits
5.4.2
deny-existence
5.4.3
get-client-cert
5.4.4
nt-uri-clean
5.4.5
ssl-logout
5.4.6
unix-uri-clean
5.5
ObjectType
5.5.1
block-auth-cert
5.5.2
block-cache-info
5.5.3
block-cipher
5.5.4
block-ip
5.5.5
block-issuer-dn
5.5.6
block-jroute
5.5.7
block-keysize
5.5.8
block-proxy-agent
5.5.9
block-secret-keysize
5.5.10
block-ssl
5.5.11
block-ssl-id
5.5.12
block-user-dn
5.5.13
block-via
5.5.14
block-xforwarded-for
5.5.15
forward-auth-cert
5.5.16
forward-cache-info
5.5.17
forward-cipher
5.5.18
forward-ip
5.5.19
forward-issuer-dn
5.5.20
forward-jroute
5.5.21
forward-keysize
5.5.22
forward-proxy-agent
5.5.23
forward-secret-keysize
5.5.24
forward-ssl
5.5.25
forward-ssl-id
5.5.26
forward-user-dn
5.5.27
forward-via
5.5.28
forward-xforwarded-for
5.5.29
http-client-config
5.5.30
proxy-cache-config
5.5.31
proxy-cache-override-http
5.5.32
proxy-websocket-config
5.5.33
reverse-block-date
5.5.34
reverse-block-server
5.5.35
reverse-forward-date
5.5.36
reverse-forward-server
5.5.37
set-basic-auth
5.5.38
set-cache-control
5.5.39
set-cookie
5.5.40
type-by-exp
5.5.41
type-by-extension
5.6
Input
5.7
Output
5.8
Route
5.8.1
set-origin-server
5.8.2
set-proxy-server
5.9
Service
5.9.1
proxy-retrieve
5.9.2
remove-filter
5.9.3
service-proxy-cache-dump
5.9.4
service-trace
5.9.5
stats-xml
5.10
AddLog
5.10.1
flex-log
5.11
Error
5.11.1
qos-error
5.11.2
send-error
5.12
Common SAFs
5.12.1
insert-filter
5.12.2
match-browser
5.12.3
redirect
5.12.4
remove-filter
5.12.4.1
Example
5.12.5
restart
5.12.6
rewrite-cookie
5.12.7
sed-param-name
5.12.8
sed-param-value
5.12.9
sed-response-header
5.12.10
set-priority
5.12.11
set-variable
A
Using Variables, Expressions, Wildcards, and String Interpolation
A.1
If, ElseIf, and Else Tags
A.2
Variables
A.2.1
Predefined Variables
A.2.2
Custom Variables
A.2.3
Resolving Variables
A.3
Expressions
A.3.1
Expression Syntax
A.3.2
Expression Results as Boolean Values
A.3.3
Expression Literals
A.3.3.1
String Literals
A.3.3.2
Numeric Literals
A.3.4
Expression Variables
A.3.5
Expression Operators
A.3.6
Expression Functions
A.3.6.1
atime
A.3.6.2
choose
A.3.6.3
ctime
A.3.6.4
escape
A.3.6.5
external
A.3.6.6
httpdate
A.3.6.7
lc
A.3.6.8
length
A.3.6.9
lookup
A.3.6.10
lookupregex
A.3.6.11
mtime
A.3.6.12
owner
A.3.6.13
uc
A.3.6.14
unescape
A.3.6.15
uuid
A.3.7
Regular Expressions
A.4
String Interpolation
A.4.1
Using Variables in Interpolated Strings
A.4.2
Using Expressions in Interpolated Strings
A.5
Wildcard Patterns
B
Using the Custom Access-Log File Format
C
Using Time Formats
D
Alphabetical List of Server Configuration Elements and Predefined SAFs
Scripting on this page enhances content navigation, but does not change the content in any way.