OSDN Git Service

Merge branch 'duplicated-logcheck' into buildenv
[ultramonkey-l7/ultramonkey-l7-v2.git] / man / l7vsadm.8
1 .TH L7VSADM 8 "12 Aug 2009" "UltraMonkey-L7"
2 .SH NAME
3 .B l7vsadm
4 \- UltraMonkey-L7 administration tool
5 .SH SYNOPSIS
6 .B l7vsadm
7 [\-A | \-E] \-t \fIservice\-address\fR:\fIserivice\-port\fR \-m \fIproto\-module\fR [\fImodule\-args\fR] [\-s \fIscheduler\fR] [\-u \fIconnection\-count\fR] [\-b \fIsorry\-server\fR] [\-f \fIsorry\-flag\fR] [\-Q \fIQoSval\-service\fR] [\-q \fIQoSval\-clients\fR]
8
9 .B l7vsadm
10 \-D \-t \fIservice\-address\fR:\fIserivice\-port\fR  \-m \fIproto\-module\fR [\fImodule\-args\fR]
11
12 .B l7vsadm
13 \-C
14
15 .B l7vsadm
16 [\-a | \-e] -t \fIservice\-address\fR:\fIserivice\-port\fR  \-m \fIproto\-module\fR [\fImodule\-args\fR] \-r \fIserver\-address\fR:\fIserver\-port\fR  [\-w \fIweight\fR]
17
18 .B l7vsadm
19 \-d \-t \fIservice\-address\fR:\fIserivice\-port\fR  \-m \fIproto\-module\fR [\fImodule\-args\fR] \-r \fIserver\-address\fR:\fIserver\-port\fR 
20
21 .B l7vsadm
22 \-R [\-s \fIreplication\-switch\fR | \-f | \-d]
23
24 .B l7vsadm
25 \-L \-c \fIlog\-category\fR \-l \fIlog\-level\fR
26
27 .B l7vsadm
28 \-P \-r \fIreload\-parameter\fR
29
30 .B l7vsadm
31 \-l [\-n]
32
33 .B l7vsadm
34 \-V [\-n]
35
36 .B l7vsadm
37 \-K [\-n]
38
39 .B l7vsadm
40 \-h
41
42 .SH DESCRIPTION
43 Control the virtual services, alternating logging levels and etc...
44
45 .TP
46 .B "\-A, \-\-add\-service"
47 Add the virtual service. Must be used with \-t and \-m arguments.
48
49 .TP
50 .B "\-E, \-\-edit\-service"
51 Edit the virtual service. Must be used with \-t and \-m arguments.
52
53 .TP
54 .B "\-D, \-\-delete\-service"
55 Delete the virtual service. Must be used with \-t and \-m arguments.
56
57 .TP
58 .B "\-C, \-\-flush"
59 Flush all virtual services.
60
61 .TP
62 .B "\-a, \-\-add\-server"
63 Add the real server to existing virtual service. 
64
65 .br 
66 # l7vsadm -A -t 192.168.0.1:80 -m sessionless
67 .br 
68 # l7vsadm -a -t 192.168.0.1:80 -m sessionless -r 192.168.0.100:80 
69
70 .TP
71 .B "\-e, \-\-edit\-server"
72 Edit the real server that registered to the existing virtual service.
73
74 .br
75 # l7vsadm -A -t 192.168.0.1:80 -m sessionless
76 .br
77 # l7vsadm -a -t 192.168.0.1:80 -m sessionless -r 192.168.9.100:80 -w 1
78 .br
79 # l7vsadm -e -t 192.168.0.1:80 -m sessionless -r 192.168.9.100:80 -w 0
80
81 .TP
82 .B "\-d, \-\-delete\-server"
83 Delete the real server that registered to the existing virtual service.
84
85 .br
86 # l7vsadm -A -t 192.168.0.1:80 -m sessionless
87 .br
88 # l7vsadm -a -t 192.168.0.1:80 -m sessionless -r 192.168.9.100:80
89 .br
90 # l7vsadm -d -t 192.168.0.1:80 -m sessionless -r 192.168.9.100:80
91
92
93 .TP
94 .B "\-R, \-\-replication"
95 Edit replication function. This option must be using with \fB\-L\fR or \fB\-P\fR option.
96
97 .TP
98 .B "\-L, \-\-log"
99 Edit logging level. Must be used with \fB\-c\fR option.
100
101 .TP
102 .B "\-P, \-\-parameter"
103 Reload configuration file. Must be used with \fB\-r\fR option.
104
105 .TP
106 .B \-l, \-\-list
107 List the registered virtual services.
108
109 .TP
110 .B \-K \-\-key
111 List the registered virtual services with keywords.
112
113 .TP
114 .B \-V, \-\-verbose
115 List the registered virtual services, keywords and settings.
116
117
118 .TP
119 .B \-h \-\-help
120 Show help messages.
121
122
123 .SH OPTIONS
124
125 .TP
126 .B "\-t , \-\-tcp\-service \fIservice\-address\fR"
127 Create the TCP service. 
128
129 .br
130 \fIservice\-address\fR := { IPv4ADDR | HOSTNAME }:{PORTNUM | SERVICENAME }
131
132
133 .TP
134 .B "\-m , \-\-proto\-module \fIproto\-module\fR \fI[module\-args]\fR"
135 Specify the protocol module.
136
137 .br
138 \fIproto\-module\fR := { url | sslid | sessionless | pfilter | ip }
139
140 .br 
141 \fImodule\-args\fR := see the operation manual.
142
143 .TP
144 .B "\-s, \-\-scheduler \fIscheduler\fR"
145 Specify the scheduler module.
146
147 .br
148 \fIscheduler\fR := { rr | lc | wrr }
149
150 .TP
151 .B "\-u, \-\-upper \fIconnection\-count\fR"
152 Set up maximum connection limit.
153
154 .br
155 \fIconnection\-count\fR := { 0 - 10000 }
156
157 .TP
158 .B "\-b, \-\-bypass \fIsorry\-server\fR"
159 Set up sorry server.
160
161 .br
162 \fIsorry\-server\fR := { IPv4ADDR | HOSTNAME }:{PORTNUM | SERVICENAME }
163
164 .TP
165 .B "\-f, \-\-flag \fIsorry\-flag\fR"
166 Switch sorry server flag. When \fBsorry\-flag\fR is 0, switched off.
167
168 .br
169 \fIsorry\-flag\fR := { 0 | 1 }
170
171 .TP
172 .B "\-Q, \-\-qos\-up \fIQoSVal\-up\fR"
173 Set QoS(client->realserver) limit.
174
175 .TP
176 .B "\-q, \-\-qos\-down \fIQoSVal\-down\fR"
177 Set QoS(realserver->client) limit.
178
179 .TP
180 .B "\-r, \-\-real\-server \fIserver\-address\fR"
181 Specify the real server.
182
183 .br
184 \fIsorry\-server\fR := { IPv4ADDR | HOSTNAME }:{PORTNUM | SERVICENAME }
185
186 .TP
187 .B "\-w, \-\-weight \fIweight\fR"
188 Set up weight value.
189
190 .TP
191 .B "\-s , \-\-status \fIreplication\-switch\fR"
192 Switch replication system.
193
194 .br
195 \fIreplication\-switch\fR := { start | stop }
196
197
198 .TP
199 .B "\-f, \-\-force"
200 Run force replication.
201
202 .TP
203 .B "\-d, \-\-dump"
204 Dump replication data area.
205
206 .TP
207 .B "\-c , \-\-category \fIlog\-category\fR"
208 Specify target log category.
209
210 .br
211 \fIlog\-category\fR := { l7vsd_network | l7vsd_network.bandwidth | l7vsd_network.num_connection | l7vsd_network.qos | l7vsd_virtual_service | l7vsd_real_server | l7vsd_real_server.balancing | l7vsd_sorry_server | l7vsd_replication | l7vsd_start_stop | l7vsd_system | l7vsd_system.memory | l7vsd_system.socket | l7vsd_system.signal | l7vsd_environment | l7vsd_environment.parameter | l7vsd_logger | l7vsd_parameter | l7vsd_event | l7vsd_schedule | l7vsd_program | l7vsd_protocol | l7vsd_module | all }
212
213 .TP
214 .B -l , \-\-level \fIlevel\fR
215 Specify logging level.
216
217 .br
218 \fIlevel\fR := { fatal | error | warn | info | debug }
219
220 .TP
221 .B "\-r, \-\-reload \fIreload\-parameter\fR"
222
223 Reload configuration file.
224
225 .br
226 \fIreload\-parameter\fR := { all | replication | logger }
227
228 .TP
229 .B "\-n, \-\-numeric"
230 Don't resolve hostname and service name when listing the virtual services and real server.
231
232
233 .SH SEE ALSO
234 .BR l7vsd (8)
235
236 .SH AUTHOR
237 UltraMonkey-L7 Project team <ultramonkey-l7-users@lists.sourceforge.jp>