xref: /aosp_15_r20/external/iptables/extensions/libipt_CLUSTERIP.man (revision a71a954618bbadd4a345637e5edcf36eec826889)
1*a71a9546SAutomerger Merge WorkerThis module allows you to configure a simple cluster of nodes that share
2*a71a9546SAutomerger Merge Workera certain IP and MAC address without an explicit load balancer in front of
3*a71a9546SAutomerger Merge Workerthem.  Connections are statically distributed between the nodes in this
4*a71a9546SAutomerger Merge Workercluster.
5*a71a9546SAutomerger Merge Worker.PP
6*a71a9546SAutomerger Merge WorkerPlease note that CLUSTERIP target is considered deprecated in favour of cluster
7*a71a9546SAutomerger Merge Workermatch which is more flexible and not limited to IPv4.
8*a71a9546SAutomerger Merge Worker.TP
9*a71a9546SAutomerger Merge Worker\fB\-\-new\fP
10*a71a9546SAutomerger Merge WorkerCreate a new ClusterIP.  You always have to set this on the first rule
11*a71a9546SAutomerger Merge Workerfor a given ClusterIP.
12*a71a9546SAutomerger Merge Worker.TP
13*a71a9546SAutomerger Merge Worker\fB\-\-hashmode\fP \fImode\fP
14*a71a9546SAutomerger Merge WorkerSpecify the hashing mode.  Has to be one of
15*a71a9546SAutomerger Merge Worker\fBsourceip\fP, \fBsourceip\-sourceport\fP, \fBsourceip\-sourceport\-destport\fP.
16*a71a9546SAutomerger Merge Worker.TP
17*a71a9546SAutomerger Merge Worker\fB\-\-clustermac\fP \fImac\fP
18*a71a9546SAutomerger Merge WorkerSpecify the ClusterIP MAC address. Has to be a link\-layer multicast address
19*a71a9546SAutomerger Merge Worker.TP
20*a71a9546SAutomerger Merge Worker\fB\-\-total\-nodes\fP \fInum\fP
21*a71a9546SAutomerger Merge WorkerNumber of total nodes within this cluster.
22*a71a9546SAutomerger Merge Worker.TP
23*a71a9546SAutomerger Merge Worker\fB\-\-local\-node\fP \fInum\fP
24*a71a9546SAutomerger Merge WorkerLocal node number within this cluster.
25*a71a9546SAutomerger Merge Worker.TP
26*a71a9546SAutomerger Merge Worker\fB\-\-hash\-init\fP \fIrnd\fP
27*a71a9546SAutomerger Merge WorkerSpecify the random seed used for hash initialization.
28