Oracle® Traffic Director Command-Line Reference 11g Release 1 (11.1.1.7) Part Number E21037-03 |
|
|
PDF · Mobi · ePub |
tadm set-route-prop common_options --config=config-name --vs=vs_name --route=route_name (property_name=property_value)+
Use this command to set the route properties for a virtual server.
For information about common_options
, run the help command.
--config|-c
Specify the name of the configuration to set the route properties.
--vs|-s
Specify the name of the virtual server.
--route|-r
Specify the name for route properties.
property-name=property-value
Specify name=value
pairs for one or more properties that you want to define. The name=value
pairs should be separated by spaces.
You can set the following route properties:
server:
Specifies the server name.
Values: Must be a text string.
sticky-cookie:
Specify the name of the cookie that causes subsequent requests to stick to a particular origin server.
Values: Must be a text string.
sticky-uri-param:
Specify the name of a URI parameter to inspect for route information. When the URI parameter is present in a request URI and its value contains a colon (:), followed by a route ID, the request will 'stick' to the origin server identified by that route ID.
Values: Must be a text string.
route-header:
Specify the name of the HTTP request header that is used to communicate route IDs to the origin servers.
Values: Must be a text string.
route-cookie:
Specify the name of the cookie generated by the server when it encounters a sticky-cookie
cookie in a response. The route-cookie
parameter stores the route ID that enables the server to direct subsequent requests back to the same origin server.
Values: Must be a text string.
rewrite-headers:
Specify a list of HTTP request headers separated by commas.
Values: Must be a text string.
Note:
The property rewrite-headers
enables you to specify multiple values, with each value enclosed in quotes and separated by commas.
validate-server-cert:
Specify whether the server validates the certificate presented by the origin servers.
Values: true
, false
. Default: true
.
use-keep-alive:
Specifies whether the HTTP client can use existing persistent connections for all types of requests.
Values: true
, false
. Default: true
.
keep-alive-timeout:
Specifies the maximum number (in seconds) to retain persistent connectivity.
Values: Integer. Default: 29
timeout:
Specifies the maximum number (in seconds) that a connection can be in a idle state.
Values: Integer. Default: 300
always-use-keep-alive:
Specifies whether the HTTP client can reuse existing connections for all types of requests.
Values: true
, false
. Default: false
.
protocol:
Specifies the HTTP protocol version string.
Values: Must be in a text string.
proxy-agent:
Specify whether the proxy server product name and version has to be forwarded to the origin servers.
Values: true
, false
. Default: true
.
origin-server-pool:
Specify the pool of origin servers of the type HTTP for this route.
Values: HTTP.
websocket-upgrade-enabled:
Specify whether standard HTTP(S) connections should be upgraded to bi-directional, full-duplex WebSocket connections.
Values: true
, false
. Default: true
.
websocket-idle-timeout:
The maximum number of seconds a connection can be idle.
Values: Integer (If no value is specified, then the timeout from the TCP connection thread pool (300 seconds) is used).
from:
Specify the URI prefix to map. The prefix must not contain trailing slashes.
to:
Specify the URL prefix to which the request should be mapped. The prefix must not contain trailing slashes.
buffer-size
: The size (in bytes) of individual access log buffers.
Values: 0 to 2147483647.
To reset a property to its default value, do not provide a property value.
For example, property-name=<empty_string>
tadm set-route-prop --user=admin --host=admin.example.com --password-file=./admin.passwd --port=8989 --no-prompt --config=www.example.org --vs=soa.example.org --route=route-1 keep-alive-timeout=29 from=/ to=/docs
The following exit values are returned:
0: command executed successfully
>0: error in executing the command
For more information about exit codes and syntax notations, run the help command.
help, get-route-prop, list-proxy-info, forward-proxy-info, block-proxy-info, list-routes, delete-route, create-route