.\" Man page generated from reStructuredText.
.
.TH "TRAFFIC_LINE" "8" "October 04, 2016" "6.2" "Apache Traffic Server"
.SH NAME
traffic_line \- Traffic Server command line
.
.nr rst2man-indent-level 0
.
.de1 rstReportMargin
\\$1 \\n[an-margin]
level \\n[rst2man-indent-level]
level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
-
\\n[rst2man-indent0]
\\n[rst2man-indent1]
\\n[rst2man-indent2]
..
.de1 INDENT
.\" .rstReportMargin pre:
. RS \\$1
. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
. nr rst2man-indent-level +1
.\" .rstReportMargin post:
..
.de UNINDENT
. RE
.\" indent \\n[an-margin]
.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
.nr rst2man-indent-level -1
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
This utility is deprecated as of v6.0.0, and replaced with
\fBtraffic_ctl\fP\&. You should change your tools / scripts to use this
new application instead.
.UNINDENT
.UNINDENT
.SH SYNOPSIS
.sp
\fBtraffic_line\fP [options]
.SH DESCRIPTION
.sp
\fBtraffic_line\fP is used to execute individual Traffic Server
commands and to script multiple commands in a shell.
.SH OPTIONS
.INDENT 0.0
.TP
.B \-B, \-\-bounce_cluster
Bounce all Traffic Server nodes in the cluster. Bouncing Traffic
Server shuts down and immediately restarts Traffic Server,
node\-by\-node.
.UNINDENT
.INDENT 0.0
.TP
.B \-b, \-\-bounce_local
Bounce Traffic Server on the local node. Bouncing Traffic Server
shuts down and immediately restarts the Traffic Server node.
.UNINDENT
.INDENT 0.0
.TP
.B \-C, \-\-clear_cluster
Clears accumulated statistics on all nodes in the cluster.
.UNINDENT
.INDENT 0.0
.TP
.B \-c, \-\-clear_node
Clears accumulated statistics on the local node.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-drain
This option modifies the behavior of \fI\%traffic_line \-b\fP
and \fI\%traffic_line \-L\fP such that \fBtraffic_server\fP
is not shut down until the number of active client connections
drops to the number given by the
\fBproxy.config.restart.active_client_threshold\fP configuration
variable.
.UNINDENT
.INDENT 0.0
.TP
.B \-h, \-\-help
Print usage information and exit.
.UNINDENT
.INDENT 0.0
.TP
.B \-L, \-\-restart_local
Restart the \fBtraffic_manager\fP and \fBtraffic_server\fP
processes on the local node.
.UNINDENT
.INDENT 0.0
.TP
.B \-M, \-\-restart_cluster
Restart the \fBtraffic_manager\fP process and the
\fBtraffic_server\fP process on all the nodes in a cluster.
.UNINDENT
.INDENT 0.0
.TP
.B \-m REGEX, \-\-match_var REGEX
Display the current values of all performance statistics or configuration
variables whose names match the given regular expression.
.UNINDENT
.INDENT 0.0
.TP
.B \-r VAR, \-\-read_var VAR
Display specific performance statistics or a current configuration
setting.
.UNINDENT
.INDENT 0.0
.TP
.B \-s VAR, \-\-set_var VAR
Set the configuration variable named \fIVAR\fP\&. The value of the configuration
variable is given by the \fI\%traffic_line \-v\fP option.
Refer to the \fBrecords.config\fP documentation for a list
of the configuration variables you can specify.
.UNINDENT
.INDENT 0.0
.TP
.B \-S, \-\-shutdown
Shut down Traffic Server on the local node.
.UNINDENT
.INDENT 0.0
.TP
.B \-U, \-\-startup
Start Traffic Server on the local node.
.UNINDENT
.INDENT 0.0
.TP
.B \-v VALUE, \-\-value VALUE
Specify the value to set when setting a configuration variable.
.UNINDENT
.INDENT 0.0
.TP
.B \-V, \-\-version
Print version information and exit.
.UNINDENT
.INDENT 0.0
.TP
.B \-x, \-\-reread_config
Initiate a Traffic Server configuration file reread. Use this
command to update the running configuration after any configuration
file modification.
.sp
The timestamp of the last reconfiguration event (in seconds
since epoch) is published in the \fIproxy.node.config.reconfigure_time\fP
metric.
.UNINDENT
.INDENT 0.0
.TP
.B \-Z, \-\-zero_cluster
Reset performance statistics to zero across the cluster.
.UNINDENT
.INDENT 0.0
.TP
.B \-z, \-\-zero_node
Reset performance statistics to zero on the local node.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-offline PATH
Mark a cache storage device as offline. The storage is identified by a \fIpath\fP which must match exactly a path
specified in \fBstorage.config\fP\&. This removes the storage from the cache and redirects requests that would have
used this storage to other storage. This has exactly the same effect as a disk failure for that storage. This does
not persist across restarts of the \fBtraffic_server\fP process.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-alarms
List all alarm events that have not been acknowledged (cleared).
.UNINDENT
.INDENT 0.0
.TP
.B \-\-clear_alarms [all | #event | name]
Clear (acknowledge) an alarm event. The arguments are "all" for all current
alarms, a specific alarm number (e.g. \(aq\(aq1\(aq\(aq), or an alarm string identifier
(e.g. \(aq\(aqMGMT_ALARM_PROXY_CONFIG_ERROR\(aq\(aq).
.UNINDENT
.INDENT 0.0
.TP
.B \-\-status
Show the current proxy server status, indicating if we\(aqre running or not.
.UNINDENT
.SH PERFORMANCE STATISTICS
.INDENT 0.0
.TP
.B proxy.process.ssl.user_agent_other_errors
Total number of \fIother\fP ssl client connection errors (counts ssl
errors that are not captured in other user agent stats below)
.TP
.B proxy.process.ssl.user_agent_expired_cert
Total number of ssl client connection failures where the cert was
expired.
.TP
.B proxy.process.ssl.user_agent_revoked_cert
Total number of ssl client connection failures where the cert was
revoked.
.TP
.B proxy.process.ssl.user_agent_unknown_cert
Total number of ssl client connection failures related to the cert,
but specific error was unknown.
.TP
.B proxy.process.ssl.user_agent_cert_verify_failed
Total number of ssl client connection failures where cert verification
failed.
.TP
.B proxy.process.ssl.user_agent_bad_cert
Total number of ssl client connection failures where the cert is bad.
.TP
.B proxy.process.ssl.user_agent_decryption_failed
Total number of ssl client connection decryption failures (during
negotiation).
.TP
.B proxy.process.ssl.user_agent_wrong_version
Total number of ssl client connections that provided an invalid protocol
version.
.TP
.B proxy.process.ssl.user_agent_unknown_ca
Total number of ssl client connection that failed due to unknown ca.
.TP
.B proxy.process.ssl.origin_server_other_errors
Total number of \fIother\fP ssl origin server connection errors (counts ssl
errors that are not captured in other origin server stats below).
.TP
.B proxy.process.ssl.origin_server_expired_cert
Total number of ssl origin server connection failures where the cert
was expired.
.TP
.B proxy.process.ssl.origin_server_revoked_cert
Total number of ssl origin server connection failures where the cert
was revoked.
.TP
.B proxy.process.ssl.origin_server_unknown_cert
Total number of ssl origin server connection failures related to the
cert where specific error was unknown.
.TP
.B proxy.process.ssl.origin_server_cert_verify_failed
Total number of ssl origin server connection failures where cert
verification failed.
.TP
.B proxy.process.ssl.origin_server_bad_cert
Total number of ssl origin server connection failures where the cert
is bad.
.TP
.B proxy.process.ssl.origin_server_decryption_failed
Total number of ssl origin server connection decryption failures
(during negotiation).
.TP
.B proxy.process.ssl.origin_server_wrong_version
Total number of ssl origin server connections that provided an invalid
protocol version.
.TP
.B proxy.process.ssl.origin_server_unknown_ca
Total number of ssl origin server connection that failed due to
unknown ca.
.TP
.B proxy.process.ssl.user_agent_sessions
Total number of ssl/tls sessions created.
.TP
.B proxy.process.ssl.user_agent_session_hit
Total number of session hits.  A previous session was reused which
resulted in an abbreviated ssl client negotiation.
.TP
.B proxy.process.ssl.user_agent_session_miss
Total number of session misses.  The ssl client provided a session id
that was not found in cache and, therefore, could not be used.
.TP
.B proxy.process.ssl.user_agent_session_timeout
Total number of session timeouts.  The ssl client provided a session, but
it could not be used because it was past the session timeout.
.TP
.B proxy.process.ssl.cipher.user_agent.{CIPHERNAME}
Total number of ssl client connections that used cipherName.  The
list of cipher statistics is dynamic and depends upon the installed
ciphers and the \fBproxy.config.ssl.server.cipher_suite\fP
configuration. The set of cipher statistics can be discovered
with \fI\%traffic_line \-m\fP\&. For example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
$ traffic_line \-m proxy.process.ssl.cipher.user_agent.
proxy.process.ssl.cipher.user_agent.ECDHE\-RSA\-AES256\-GCM\-SHA384 0
proxy.process.ssl.cipher.user_agent.ECDHE\-ECDSA\-AES256\-GCM\-SHA384 0
proxy.process.ssl.cipher.user_agent.ECDHE\-RSA\-AES256\-SHA384 0
proxy.process.ssl.cipher.user_agent.ECDHE\-ECDSA\-AES256\-SHA384 0
\&...
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SH CACHE STATISTICS
.sp
Cache statistics come in two varieties, global and per cache volume. These will be listed here in the global form. To get a
cache volume statistic add \fI\&.volume_#\fP to the name after \fIcache\fP where \fI#\fP is 1\-based index of the volume in \fBstorage.config\fP\&.
For example the statistic \fIproxy.process.cache.sync.bytes\fP is a global statistic. The value for the third cache volume is
\fIproxy.process.cache.volume_3.sync.bytes\fP\&.
.INDENT 0.0
.TP
.B proxy.process.cache.sync.bytes
The total number of bytes written to disk to synchronize the cache directory.
.TP
.B proxy.process.cache.sync.time
The total time, in nanoseconds, during which the cache directory was being written to disk.
.TP
.B proxy.process.cache.sync.count
The number of times a cache directory sync has been done.
.TP
.B proxy.process.cache.wrap_count
The number of times a cache stripe has cycled. Each stripe is a circular buffer and this is incremented each time the
write cursor is reset to the start of the stripe.
.UNINDENT
.SH EXAMPLES
.sp
Configure Traffic Server to log in Squid format:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
$ traffic_line \-s proxy.config.log.squid_log_enabled \-v 1
$ traffic_line \-s proxy.config.log.squid_log_is_ascii \-v 1
$ traffic_ctl config reload
.ft P
.fi
.UNINDENT
.UNINDENT
.SH SEE ALSO
.sp
\fIrecords.config(5)\fP,
\fIstorage.config(5)\fP
.SH COPYRIGHT
2015, dev@trafficserver.apache.org
.\" Generated by docutils manpage writer.
.