Oracle iPlanet Web Proxy Server 4.0.14 Configuration File Reference

`icp.conf`

This file is used to configure the Internet Cache Protocol (ICP) feature of the server. The three functions in the icp.conf file are add_parent, add_sibling, and server. Each function can be called as many times as necessary. Each should be on a separate line.

add_parent

The add_parent function identifies and configures a parent server in an ICP neighborhood.

Syntax

add_parent name=name icp_port=port number proxy_port=port number 
	mcast_address=IP address ttl=number round=1|2

Note –

The above text should be on one line in the icp.conf file.

Parameters

name specifies the name of the parent server. This value can be a DNS name or an IP address.

icp_port specifies the port on which the parent listens for ICP messages.

proxy_port specifies the port for the proxy on the parent.

mcast_address specifies the multicast address the parent listens to. A multicast address is an IP address to which multiple servers can listen. Using a multicast address enables a proxy to send one query to the network that all neighbors listening to that multicast address can receive. This process eliminates the need to send a query to each neighbor separately.

ttl specifies the time to live for a message sent to the multicast address. ttl controls the number of subnets a multicast message will be forwarded to. If the ttl is set to 1, the multicast message will only be forwarded to the local subnet. If the ttl is set to 2, the message will go to all subnets that are one hop away.

round specifies in which polling ro-und the parent will be queried. A polling round is an ICP query cycle. Possible values are:

1 - The parent will be queried in the first query cycle with all other round one neighbors.
2 - The parent will only be queried if none of the neighbors in polling round one return a HIT.

Example

add_parent name=proxy1 icp_port=5151 proxy_port=3333 
	mcast_address=189.98.3.33 ttl=3 round=2

add_sibling

The add_sibling function identifies and configures a sibling server in an ICP neighborhood.

Syntax

add_sibling name=name icp_port=port number proxy_port=port number 
	mcast_address=IP address ttl=number round=1|2

Note –

The above text will all be on one line in the icp.conf file.

Parameters

name specifies the name of the sibling server, which can be a DNS name or an IP address.

icp_port specifies the port on which the sibling listens for ICP messages.

proxy_port specifies the port for the proxy on the sibling.

mcast_address specifies the multicast address the sibling listens to. A multicast address is an IP address to which multiple servers can listen. Using a multicast address enables a proxy to send one query to the network that all neighbors listening to that multicast address can receive. This process eliminates the need to send a query to each neighbor separately.

round specifies in which polling round the sibling will be queried. A polling round is an ICP query cycle. Possible values are:

1 - The sibling will be queried in the first query cycle with all other round one neighbors. This is the default polling round value.
2 - The sibling will only be queried if none of the neighbors in polling round one return a HIT.

Example

add_sibling name=proxy2 icp_port=5151 proxy_port=3333 
	mcast_address=190.99.2.11 ttl=2 round=1

Note –

The above text will all be on one line in the icp.conf file.

server

The server function identifies and configures the local proxy in an ICP neighborhood.

Syntax

server bind_address=IP-address mcast=IP-address num_servers=number 
	icp_port=port-number default_route=name 
default_route_port=port number 
no_hit_behavior=fastest_parent|default timeout=seconds

Note –

The above text should be on one line in the icp.conf file.

Parameters

bind_address specifies the IP address to which the server will bind. For machines with more than one IP address, this parameter can be used to determine which address the ICP server will bind to.

mcast the multicast address to which the neighbor listens. A multicast address is an IP address to which multiple servers can listen. Using a multicast address enables a proxy to send one query to the network that all neighbors who are listening to that multicast address can see. The process eliminates the need to send a query to each neighbor separately.

If both a multicast address and bind address are specified for the neighbor, the neighbor uses the bind address to communicate with other neighbors. If neither a bind address nor a multicast address is specified, the communication subsystem will decide which address to use to send the data.

num_servers specifies the number of processes that will service ICP requests.

icp_port specifies the port number to which the server will listen.

default_route tells the proxy server where to route a request when none of the neighboring caches respond. If default_route and default_route_port are set to origin, the proxy server will route defaulted requests to the origin server. The meaning of default_route is different depending on the value of no_hit_behavior. If no_hit_behavior is set to default, the default_route is used when none of the proxy array members return a hit. If no_hit_behavior is set to fastest_parent, the default_route value is used only if no parent responds.

default_route_port specifies the port number of the machine specified as the default_route. If default_route and default_route_port are set to origin, the proxy server will route defaulted requests to the origin server.

timeout specifies the maximum number of milliseconds the proxy will wait for an ICP response.

no_hit_behavior specifies the proxy’s behavior whenever none of the neighbors returns a hit for the requested document. Possible values are:

fastest_parent - The request is routed through the first parent that returned a miss.
default - The request is routed to the machine specified as the default route.

Example

server bind_address=198.4.66.78 mcast=no num_servers=5 icp_port=5151 
	default_route=proxy1 default_route_port=8080 no_hit_behavior=fastest_parent 
	timeout=2000

Note –