.\" Man page generated from reStructuredText.
.
.TH "ICP.CONFIG" "5" "October 04, 2016" "6.2" "Apache Traffic Server"
.SH NAME
icp.config \- Traffic Server ICP configuration file
.
.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
The \fI\%icp.config\fP file defines ICP peers (parent and sibling caches).
.sp
\fBIMPORTANT:\fP
.INDENT 0.0
.INDENT 3.5
After you modify the icp.config file, navigate to the
Traffic Server bin directory and run the \fItraffic_ctl config reload\fP command to
apply the changes. When you apply the changes to a node in a cluster,
Traffic Server automatically applies the changes to all other nodes in
the cluster.
.UNINDENT
.UNINDENT
.SH FORMAT
.sp
Each line in the icp.config file contains the name and configuration
information for a single ICP peer in the following format:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
host : host_IP : ctype : proxy_port : icp_port : MC_on : MC_IP : MC_TTL :
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Each field is described in the following list.
.INDENT 0.0
.TP
.B \fBhost\fP
The hostname of the ICP peer.
.sp
This field is optional; if you do not specify the hostname of the
ICP peer, you must specify the IP address.
.TP
.B \fBhost_IP\fP
The IP address of the ICP peer.
.sp
This field is optional; if you do not specify the IP address of the
ICP peer, you must specify the hostname.
.TP
.B \fBctype\fP
Use the following options:
.INDENT 7.0
.IP \(bu 2
1 to indicate an ICP parent cache
.IP \(bu 2
2 to indicate an ICP sibling cache
.IP \(bu 2
3 to indicate an ICP local cache
.UNINDENT
.TP
.B \fBproxy_port\fP
The port number of the TCP port used by the ICP peer for proxy
communication.
.TP
.B \fBicp_port\fP
The port number of the UDP port used by the ICP peer for ICP
communication.
.TP
.B \fBMC_on\fP
Enable or disable MultiCast:
.INDENT 7.0
.IP \(bu 2
0 if multicast is disabled
.IP \(bu 2
1 if multicast is enabled
.UNINDENT
.TP
.B \fBMC_ip\fP
The MultiCast IP address.
.TP
.B \fBMC_ttl\fP
The multicast time to live. Use the following options:
.INDENT 7.0
.IP \(bu 2
1 if IP multicast datagrams will not be forwarded beyond a single
subnetwork
.IP \(bu 2
2 to allow delivery of IP multicast datagrams to more than one
subnet (if there are one or more multicast routers attached to
the first hop subnet).
.UNINDENT
.UNINDENT
.SH EXAMPLES
.sp
The following example configuration is for three nodes: the local host,
one parent, and one sibling.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
localhost:0.0.0.0:3:8080:3130:0:0.0.0.0:1
host1:123.12.1.23:1:8080:3131:0:0.0.0.0:1
host2:123.12.1.24:2:8080:3131:0:0.0.0.0:1
.ft P
.fi
.UNINDENT
.UNINDENT
.SH COPYRIGHT
2015, dev@trafficserver.apache.org
.\" Generated by docutils manpage writer.
.