doc/man/l7vsadm.8

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