--------------------- PatchSet 11434 Date: 2007/05/13 23:38:55 Author: adrian Branch: HEAD Tag: (none) Log: Shuffle the WCCPv1/WCCPv2 options around into its own defined section. Members: src/cf.data.pre:1.391->1.392 Index: squid/src/cf.data.pre =================================================================== RCS file: /cvsroot/squid/squid/src/cf.data.pre,v retrieving revision 1.391 retrieving revision 1.392 diff -u -r1.391 -r1.392 --- squid/src/cf.data.pre 13 May 2007 21:26:47 -0000 1.391 +++ squid/src/cf.data.pre 13 May 2007 23:38:55 -0000 1.392 @@ -1,6 +1,6 @@ # -# $Id: cf.data.pre,v 1.391 2007/05/13 21:26:47 hno Exp $ +# $Id: cf.data.pre,v 1.392 2007/05/13 23:38:55 adrian Exp $ # # # SQUID Web Proxy Cache http://www.squid-cache.org/ @@ -3630,6 +3630,208 @@ "seen" by squid). DOC_END +COMMENT_START + + Configuration options relating to WCCPv1 and WCCPv2. + ----------------------------------------------------------------------------- + +COMMENT_END + +NAME: wccp_router +TYPE: address +LOC: Config.Wccp.router +DEFAULT: 0.0.0.0 +IFDEF: USE_WCCP +DOC_NONE +NAME: wccp2_router +TYPE: sockaddr_in_list +LOC: Config.Wccp2.router +DEFAULT: none +IFDEF: USE_WCCPv2 +DOC_START + Use this option to define your WCCP ``home'' router for + Squid. + + wccp_router supports a single WCCP(v1) router + + wccp2_router supports multiple WCCPv2 routers + + only one of the two may be used at the same time and defines + which version of WCCP to use. +DOC_END + +NAME: wccp_version +TYPE: int +LOC: Config.Wccp.version +DEFAULT: 4 +IFDEF: USE_WCCP +DOC_START + This directive is only relevant if you need to set up WCCP(v1) + to some very old and end-of-life Cisco routers. In all other + setups it must be left unset or at the default setting. + It defines an internal version in the WCCP(v1) protocol, + with version 4 being the officially documented protocol. + + According to some users, Cisco IOS 11.2 and earlier only + support WCCP version 3. If you're using that or an earlier + version of IOS, you may need to change this value to 3, otherwise + do not specify this parameter. +DOC_END + +NAME: wccp2_rebuild_wait +TYPE: onoff +LOC: Config.Wccp2.rebuildwait +DEFAULT: on +IFDEF: USE_WCCPv2 +DOC_START + If this is enabled Squid will wait for the cache dir rebuild to finish + before sending the first wccp2 HereIAm packet +DOC_END + +NAME: wccp2_forwarding_method +TYPE: int +LOC: Config.Wccp2.forwarding_method +DEFAULT: 1 +IFDEF: USE_WCCPv2 +DOC_START + WCCP2 allows the setting of forwarding methods between the + router/switch and the cache. Valid values are as follows: + + 1 - GRE encapsulation (forward the packet in a GRE/WCCP tunnel) + 2 - L2 redirect (forward the packet using Layer 2/MAC rewriting) + + Currently (as of IOS 12.4) cisco routers only support GRE. + Cisco switches only support the L2 redirect assignment method. +DOC_END + +NAME: wccp2_return_method +TYPE: int +LOC: Config.Wccp2.return_method +DEFAULT: 1 +IFDEF: USE_WCCPv2 +DOC_START + WCCP2 allows the setting of return methods between the + router/switch and the cache for packets that the cache + decides not to handle. Valid values are as follows: + + 1 - GRE encapsulation (forward the packet in a GRE/WCCP tunnel) + 2 - L2 redirect (forward the packet using Layer 2/MAC rewriting) + + Currently (as of IOS 12.4) cisco routers only support GRE. + Cisco switches only support the L2 redirect assignment. + + If the "ip wccp redirect exclude in" command has been + enabled on the cache interface, then it is still safe for + the proxy server to use a l2 redirect method even if this + option is set to GRE. +DOC_END + +NAME: wccp2_assignment_method +TYPE: int +LOC: Config.Wccp2.assignment_method +DEFAULT: 1 +IFDEF: USE_WCCPv2 +DOC_START + WCCP2 allows the setting of methods to assign the WCCP hash + Valid values are as follows: + + 1 - Hash assignment + 2 - Mask assignment + + As a general rule, cisco routers support the hash assignment method + and cisco switches support the mask assignment method. +DOC_END + +NAME: wccp2_service +TYPE: wccp2_service +LOC: Config.Wccp2.info +DEFAULT: none +DEFAULT_IF_NONE: standard 0 +IFDEF: USE_WCCPv2 +DOC_START + WCCP2 allows for multiple traffic services. There are two + types: "standard" and "dynamic". The standard type defines + one service id - http (id 0). The dynamic service ids can be from + 51 to 255 inclusive. In order to use a dynamic service id + one must define the type of traffic to be redirected; this is done + using the wccp2_service_info option. + + The "standard" type does not require a wccp2_service_info option, + just specifying the service id will suffice. + + MD5 service authentication can be enabled by adding + "password=" to the end of this service declaration. + + Examples: + + wccp2_service standard 0 # for the 'web-cache' standard service + wccp2_service dynamic 80 # a dynamic service type which will be + # fleshed out with subsequent options. + wccp2_service standard 0 password=foo + +DOC_END + +NAME: wccp2_service_info +TYPE: wccp2_service_info +LOC: Config.Wccp2.info +DEFAULT: none +IFDEF: USE_WCCPv2 +DOC_START + Dynamic WCCPv2 services require further information to define the + traffic you wish to have diverted. + + The format is: + + wccp2_service_info protocol= flags=,.. + priority= ports=,.. + + The relevant WCCPv2 flags: + + src_ip_hash, dst_ip_hash + + source_port_hash, dest_port_hash + + src_ip_alt_hash, dst_ip_alt_hash + + src_port_alt_hash, dst_port_alt_hash + + ports_source + + The port list can be one to eight entries. + + Example: + + wccp2_service_info 80 protocol=tcp flags=src_ip_hash,ports_source + priority=240 ports=80 + + Note: the service id must have been defined by a previous + 'wccp2_service dynamic ' entry. +DOC_END + +NAME: wccp2_weight +TYPE: int +LOC: Config.Wccp2.weight +DEFAULT: 10000 +IFDEF: USE_WCCPv2 +DOC_START + Each cache server gets assigned a set of the destination + hash proportional to their weight. +DOC_END + +NAME: wccp_address +TYPE: address +LOC: Config.Wccp.address +DEFAULT: 0.0.0.0 +IFDEF: USE_WCCP +DOC_NONE +NAME: wccp2_address +TYPE: address +LOC: Config.Wccp2.address +DEFAULT: 0.0.0.0 +IFDEF: USE_WCCPv2 +DOC_START + Use this option if you require WCCP to use a specific + interface address. + + The default behavior is to not bind to any specific address. +DOC_END + + COMMENT_START MISCELLANEOUS @@ -4379,200 +4581,6 @@ queried only when Squid starts up, not for every request. DOC_END -NAME: wccp_router -TYPE: address -LOC: Config.Wccp.router -DEFAULT: 0.0.0.0 -IFDEF: USE_WCCP -DOC_NONE -NAME: wccp2_router -TYPE: sockaddr_in_list -LOC: Config.Wccp2.router -DEFAULT: none -IFDEF: USE_WCCPv2 -DOC_START - Use this option to define your WCCP ``home'' router for - Squid. - - wccp_router supports a single WCCP(v1) router - - wccp2_router supports multiple WCCPv2 routers - - only one of the two may be used at the same time and defines - which version of WCCP to use. -DOC_END - -NAME: wccp_version -TYPE: int -LOC: Config.Wccp.version -DEFAULT: 4 -IFDEF: USE_WCCP -DOC_START - This directive is only relevant if you need to set up WCCP(v1) - to some very old and end-of-life Cisco routers. In all other - setups it must be left unset or at the default setting. - It defines an internal version in the WCCP(v1) protocol, - with version 4 being the officially documented protocol. - - According to some users, Cisco IOS 11.2 and earlier only - support WCCP version 3. If you're using that or an earlier - version of IOS, you may need to change this value to 3, otherwise - do not specify this parameter. -DOC_END - -NAME: wccp2_rebuild_wait -TYPE: onoff -LOC: Config.Wccp2.rebuildwait -DEFAULT: on -IFDEF: USE_WCCPv2 -DOC_START - If this is enabled Squid will wait for the cache dir rebuild to finish - before sending the first wccp2 HereIAm packet -DOC_END - -NAME: wccp2_forwarding_method -TYPE: int -LOC: Config.Wccp2.forwarding_method -DEFAULT: 1 -IFDEF: USE_WCCPv2 -DOC_START - WCCP2 allows the setting of forwarding methods between the - router/switch and the cache. Valid values are as follows: - - 1 - GRE encapsulation (forward the packet in a GRE/WCCP tunnel) - 2 - L2 redirect (forward the packet using Layer 2/MAC rewriting) - - Currently (as of IOS 12.4) cisco routers only support GRE. - Cisco switches only support the L2 redirect assignment method. -DOC_END - -NAME: wccp2_return_method -TYPE: int -LOC: Config.Wccp2.return_method -DEFAULT: 1 -IFDEF: USE_WCCPv2 -DOC_START - WCCP2 allows the setting of return methods between the - router/switch and the cache for packets that the cache - decides not to handle. Valid values are as follows: - - 1 - GRE encapsulation (forward the packet in a GRE/WCCP tunnel) - 2 - L2 redirect (forward the packet using Layer 2/MAC rewriting) - - Currently (as of IOS 12.4) cisco routers only support GRE. - Cisco switches only support the L2 redirect assignment. - - If the "ip wccp redirect exclude in" command has been - enabled on the cache interface, then it is still safe for - the proxy server to use a l2 redirect method even if this - option is set to GRE. -DOC_END - -NAME: wccp2_assignment_method -TYPE: int -LOC: Config.Wccp2.assignment_method -DEFAULT: 1 -IFDEF: USE_WCCPv2 -DOC_START - WCCP2 allows the setting of methods to assign the WCCP hash - Valid values are as follows: - - 1 - Hash assignment - 2 - Mask assignment - - As a general rule, cisco routers support the hash assignment method - and cisco switches support the mask assignment method. -DOC_END - -NAME: wccp2_service -TYPE: wccp2_service -LOC: Config.Wccp2.info -DEFAULT: none -DEFAULT_IF_NONE: standard 0 -IFDEF: USE_WCCPv2 -DOC_START - WCCP2 allows for multiple traffic services. There are two - types: "standard" and "dynamic". The standard type defines - one service id - http (id 0). The dynamic service ids can be from - 51 to 255 inclusive. In order to use a dynamic service id - one must define the type of traffic to be redirected; this is done - using the wccp2_service_info option. - - The "standard" type does not require a wccp2_service_info option, - just specifying the service id will suffice. - - MD5 service authentication can be enabled by adding - "password=" to the end of this service declaration. - - Examples: - - wccp2_service standard 0 # for the 'web-cache' standard service - wccp2_service dynamic 80 # a dynamic service type which will be - # fleshed out with subsequent options. - wccp2_service standard 0 password=foo - -DOC_END - -NAME: wccp2_service_info -TYPE: wccp2_service_info -LOC: Config.Wccp2.info -DEFAULT: none -IFDEF: USE_WCCPv2 -DOC_START - Dynamic WCCPv2 services require further information to define the - traffic you wish to have diverted. - - The format is: - - wccp2_service_info protocol= flags=,.. - priority= ports=,.. - - The relevant WCCPv2 flags: - + src_ip_hash, dst_ip_hash - + source_port_hash, dest_port_hash - + src_ip_alt_hash, dst_ip_alt_hash - + src_port_alt_hash, dst_port_alt_hash - + ports_source - - The port list can be one to eight entries. - - Example: - - wccp2_service_info 80 protocol=tcp flags=src_ip_hash,ports_source - priority=240 ports=80 - - Note: the service id must have been defined by a previous - 'wccp2_service dynamic ' entry. -DOC_END - -NAME: wccp2_weight -TYPE: int -LOC: Config.Wccp2.weight -DEFAULT: 10000 -IFDEF: USE_WCCPv2 -DOC_START - Each cache server gets assigned a set of the destination - hash proportional to their weight. -DOC_END - -NAME: wccp_address -TYPE: address -LOC: Config.Wccp.address -DEFAULT: 0.0.0.0 -IFDEF: USE_WCCP -DOC_NONE -NAME: wccp2_address -TYPE: address -LOC: Config.Wccp2.address -DEFAULT: 0.0.0.0 -IFDEF: USE_WCCPv2 -DOC_START - Use this option if you require WCCP to use a specific - interface address. - - The default behavior is to not bind to any specific address. -DOC_END - NAME: incoming_icp_average TYPE: int DEFAULT: 6