ipvsctl

README

Name

A modern Linux Virtual Server controller.

Badges

Description

ipvsctl is similar to ipvsadm, ipvsctl support multiple modern operations, include sub-commands service , server, address, timeout, daemon, connection, zero, flush.

Table of Contents

• Commands
  • Service
    • List Service
    • Check Service
    • Get Service
    • Add Service
    • Update Service
    • Delete Service
    • Flush Service
  • Server
    • List Server
    • Add Server
    • Update Server
    • Delete Server
    • Flush Server
  • Address
    • List Address
    • Add Address
    • Delete Address
    • Flush Address
  • Timeout
    • Show Timeout
    • Set Timeout
  • Zero
  • Flush
  • Daemon
    • Show Daemon
    • Add Daemon
    • Delete Daemon
  • Connection
    • Show Connection
• License

Commands

./ipvsctl help
NAME:
   ipvsctl - IP Virtual Server controller

USAGE:
   ipvsctl [global options] command [command options] [arguments...]

VERSION:
   v1.3.0

DESCRIPTION:
   A modern Linux Virtual Server controller

AUTHOR:
   kwanhur <huang_hua2012@163.com>

COMMANDS:
   zero, z                                                      Zero ipvs all the virtual service stats(byte packet and rate counters)
   flush, f, clear                                              Flush out the virtual server table
   service, s, svc, vs                                          Operates virtual service[vip:vport protocol] (TCP UDP STCP)/(IPv4 IPv6)
   server, ser, svr, d, dst, dest, destination, rs, realserver  Operates real server[rip:rport] (IPv4/IPv6)
   address, a, addr, local-address, la, laddr                   Operates local address (IPv4/IPv6)
   timeout, t, to, out                                          Operates timeout (tcp tcpfin udp)
   daemon, dm                                                   Operates synchronization daemon
   connection, c, conn                                          Operates connection
   help, h                                                      Shows a list of commands or help for one command

GLOBAL OPTIONS:
   --help, -h     show help (default: false)
   --version, -v  print the version (default: false)

Service

ipvsctl can be used to set up, maintain or retrieve the virtual server table in the Linux kernel.

Supported sub-commands list, string, check, get, add, update, delete, zero, flush.

./ipvsctl service -h
NAME:
   ipvsctl service - Operates virtual service[vip:vport protocol] (TCP UDP STCP)/(IPv4 IPv6)

USAGE:
   ipvsctl service command [command options] [arguments...]

COMMANDS:
   list, l, ls                 List ipvs virtual service
   string, s, str              Present ipvs virtual service string
   check, c, chk, exist, find  Check ipvs virtual service exist or not
   get, g, fetch, one          Get ipvs virtual service
   add, a, new, n, set         Add ipvs virtual service
   update, u, up               Update ipvs virtual service
   del, d, delete              Del ipvs virtual service
   zero, z                     Zero ipvs virtual server stats(byte packet and rate counters)
   flush, f, clear             Flush out the virtual server table
   help, h                     Shows a list of commands or help for one command

OPTIONS:
   --help, -h  show help (default: false)

List Service

Retrieve all the virtual service. Supported statistics information with flag --stats or -s. Statistics includes Conn, PktsIn, PktsOut, BytesIn, BytesOut, CPS, BPSIn, BPSOut, PPSIn, PPSOut.

./ipvsctl service list -h
NAME:
   ipvsctl service list - List ipvs virtual service

USAGE:
   ipvsctl service list [command options] [arguments...]

OPTIONS:
   --stats, -s, --stat  Show statistics information (default: false)
   --help, -h           show help (default: false)

Check Service

Check specified service existed in Linux virtual server table or not.

./ipvsctl service check -h
NAME:
   ipvsctl service check - Check ipvs virtual service exist or not

USAGE:
   ipvsctl service check [command options] [arguments...]

OPTIONS:
   --vip value                      Specify vs IP address
   --vport value                    Specify vs port number, range [0-65535] (default: 0)
   --protocol value, --proto value  Specify vs protocol, option [TCP UDP SCTP] (default: TCP)
   --help, -h                       show help (default: false)

Get Service

Retrieve one virtual service. Similar to List Service

./ipvsctl service get -h
NAME:
   ipvsctl service get - Get ipvs virtual service

USAGE:
   ipvsctl service get [command options] [arguments...]

OPTIONS:
   --vip value                      Specify vs IP address
   --vport value                    Specify vs port number, range [0-65535] (default: 0)
   --protocol value, --proto value  Specify vs protocol, option [TCP UDP SCTP] (default: TCP)
   --stats, -s, --stat              Show statistics information (default: false)
   --help, -h                       show help (default: false)

Add Service

Add one virtual service into Linux virtual server table. Supported two address family (IPv4, IPv6), three protocols ( TCP, UDP, STCP), and ten load balancing algorithms (round-robin, weighted round-robin, least-connection, weighted least-connection, locality-based least-connection, locality-based least-connection with replication, destination-hashing, source-hashing, shortest expected delay and never queue).

./ipvsctl service add -h
NAME:
   ipvsctl service add - Add ipvs virtual service

USAGE:
   ipvsctl service add [command options] [arguments...]

DESCRIPTION:
   Add a virtual service. A service address is uniquely defined by a triplet: IP address, port number,  and  protocol.  Alternatively,  a virtual service may be defined by a firewall-mark.

OPTIONS:
   --vip value                                                  Specify vs IP address
   --vport value                                                Specify vs port number, range [0-65535] (default: 0)
   --protocol value, --proto value                              Specify vs protocol, option [TCP UDP SCTP] (default: TCP)
   --scheduler value, -s value, --sched value                   Specify vs scheduling method, option [rr wrr lc wlc lblc lblcr dh sh sed nq]
   --persistent value, --pe value, --per value, --persis value  Specify vs persistent name
   --timeout value                                              Specify persistent session timeout in seconds (default: 300)
   --netmask value, -M value, --mask value                      Specify which clients are grouped for persistent virtual service, default IPv4/32 IPv6/128 (default: 0)
   --help, -h                                                   show help (default: false)

Update Service

Update specified virtual service. Attributes include scheduler, persistent, timeout, netmask could be updated.

./ipvsctl service update -h
NAME:
   ipvsctl service update - Update ipvs virtual service

USAGE:
   ipvsctl service update [command options] [arguments...]

OPTIONS:
   --vip value                                                  Specify vs IP address
   --vport value                                                Specify vs port number, range [0-65535] (default: 0)
   --protocol value, --proto value                              Specify vs protocol, option [TCP UDP SCTP] (default: TCP)
   --scheduler value, -s value, --sched value                   Specify vs scheduling method, option [rr wrr lc wlc lblc lblcr dh sh sed nq]
   --persistent value, --pe value, --per value, --persis value  Specify vs persistent name
   --timeout value                                              Specify persistent session timeout in seconds (default: 300)
   --netmask value, -M value, --mask value                      Specify which clients are grouped for persistent virtual service, default IPv4/32 IPv6/128 (default: 0)
   --help, -h                                                   show help (default: false)

Delete Service

Delete specified virtual service.

./ipvsctl service delete -h
NAME:
   ipvsctl service del - Del ipvs virtual service

USAGE:
   ipvsctl service del [command options] [arguments...]

OPTIONS:
   --vip value                      Specify vs IP address
   --vport value                    Specify vs port number, range [0-65535] (default: 0)
   --protocol value, --proto value  Specify vs protocol, option [TCP UDP SCTP] (default: TCP)
   --help, -h                       show help (default: false)

Zero Service

Zero specified virtual service statistics.

./ipvsctl service zero -h
NAME:
   ipvsctl service zero - Zero ipvs virtual server stats(byte packet and rate counters)

USAGE:
   ipvsctl service zero [command options] [arguments...]

OPTIONS:
   --vip value                      Specify vs IP address
   --vport value                    Specify vs port number, range [0-65535] (default: 0)
   --protocol value, --proto value  Specify vs protocol, option [TCP UDP SCTP] (default: TCP)
   --help, -h                       show help (default: false)

Flush Service

Flush all the virtual services.

./ipvsctl service flush -h
NAME:
   ipvsctl service flush - Flush ipvs, all the rules will be clear

USAGE:
   ipvsctl service flush [command options] [arguments...]

OPTIONS:
   --help, -h  show help (default: false)

Server

ipvsctl can be used to set up, maintain or retrieve the real server table with the specified virtual server.

The Linux Virtual Server can be used to build scalable network services based on a cluster of two or more nodes. The active node of the cluster redirects service requests to a collection of server hosts that will actually perform the services.

Supported sub-commands list, add, delete, flush.

./ipvsctl server -h
NAME:
   ipvsctl server - Operates real server[rip:rport] (IPv4/IPv6)

USAGE:
   ipvsctl server command [command options] [arguments...]

COMMANDS:
   list, l, ls             List ipvs real server
   add, a, new, n, set     Add ipvs real server
   del, d, delete          Del ipvs real server
   flush, f, clear, purge  Flush rs, all the real servers will be clear
   help, h                 Shows a list of commands or help for one command

OPTIONS:
   --help, -h  show help (default: false)

List Server

Retrieve all the servers with specified virtual server. Supported statistics information with flag --stats or -s. Statistics includes ActConn, InactConn, PersConn, Conn, PktsIn, PktsOut, BytesIn, BytesOut, CPS , BPSIn, BPSOut, PPSIn, PPSOut.

./ipvsctl server list -h
NAME:
   ipvsctl server list - List ipvs real server

USAGE:
   ipvsctl server list [command options] [arguments...]

OPTIONS:
   --vip value                      Specify vs IP address
   --vport value                    Specify vs port number, range [0-65535] (default: 0)
   --protocol value, --proto value  Specify vs protocol, option [TCP UDP SCTP] (default: TCP)
   --stats, -s, --stat              Show statistics information (default: false)
   --help, -h                       show help (default: false)

Add Server

Add one real server into specified virtual service. Supported two address family (IPv4, IPv6), and seven forward modes ( local, mask, masq, bypass, direct route, tunnel, full-nat).

./ipvsctl server add -h
NAME:
   ipvsctl server add - Add ipvs real server

USAGE:
   ipvsctl server add [command options] [arguments...]

OPTIONS:
   --vip value                      Specify vs IP address
   --vport value                    Specify vs port number, range [0-65535] (default: 0)
   --protocol value, --proto value  Specify vs protocol, option [TCP UDP SCTP] (default: TCP)
   --rip value                      Specify rs IP address
   --rport value                    Specify rs port number, range [0-65535] (default: 0)
   --forward value, --fwd value     Specify rs connection flag, option [local mask masq bypass dr tun fnat] (default: dr)
   --weight value, -w value         Specify rs weight (default: 0)
   --help, -h                       show help (default: false)

Update Server

Update real server attributes forward, weight with specified virtual service.

./ipvsctl server update -h
NAME:
   ipvsctl server update - Update ipvs real server

USAGE:
   ipvsctl server update [command options] [arguments...]

OPTIONS:
   --vip value                      Specify vs IP address
   --vport value                    Specify vs port number, range [0-65535] (default: 0)
   --protocol value, --proto value  Specify vs protocol, option [TCP UDP SCTP] (default: TCP)
   --rip value                      Specify rs IP address
   --rport value                    Specify rs port number, range [0-65535] (default: 0)
   --forward value, --fwd value     Specify rs connection flag, option [local mask masq bypass dr tun fnat] (default: dr)
   --weight value, -w value         Specify rs weight (default: 0)
   --help, -h                       show help (default: false)

Delete Server

Delete one real server with specified virtual service.

./ipvsctl server delete -h
NAME:
   ipvsctl server del - Del ipvs real server

USAGE:
   ipvsctl server del [command options] [arguments...]

OPTIONS:
   --vip value                      Specify vs IP address
   --vport value                    Specify vs port number, range [0-65535] (default: 0)
   --protocol value, --proto value  Specify vs protocol, option [TCP UDP SCTP] (default: TCP)
   --rip value                      Specify rs IP address
   --rport value                    Specify rs port number, range [0-65535] (default: 0)
   --help, -h                       show help (default: false)

Flush Server

Flush all the real servers with specified virtual service.

./ipvsctl server flush -h
NAME:
   ipvsctl server flush - Flush rs, all the real servers will be clear

USAGE:
   ipvsctl server flush [command options] [arguments...]

OPTIONS:
   --vip value                      Specify vs IP address
   --vport value                    Specify vs port number, range [0-65535] (default: 0)
   --protocol value, --proto value  Specify vs protocol, option [TCP UDP SCTP] (default: TCP)
   --help, -h                       show help (default: false)

Address

ipvsctl can be used to maintain or retrieve the local address with the specified virtual server.

Supported sub-commands list, add, delete, flush.

./ipvsctl address -h
NAME:
   ipvsctl address - Operates local address (IPv4/IPv6)

USAGE:
   ipvsctl address command [command options] [arguments...]

COMMANDS:
   list, l, ls             List ipvs local address
   add, a, new, n, set     Add ipvs local address
   del, d, delete          Del ipvs local address
   flush, f, clear, purge  Flush all the local address
   help, h                 Shows a list of commands or help for one command

OPTIONS:
   --help, -h  show help (default: false)

List Address

Retrieve all the local addresses with specified virtual server. Supported statistics information includes Conflict , Connection.

./ipvsctl address list -h
NAME:
   ipvsctl address list - List ipvs local address

USAGE:
   ipvsctl address list [command options] [arguments...]

OPTIONS:
   --vip value                      Specify vs IP address
   --vport value                    Specify vs port number, range [0-65535] (default: 0)
   --protocol value, --proto value  Specify vs protocol, option [TCP UDP SCTP] (default: TCP)
   --help, -h                       show help (default: false)

Add Address

Add local address into specified virtual service. Supported two address family (IPv4, IPv6).

./ipvsctl address add -h
NAME:
   ipvsctl address add - Add ipvs local address

USAGE:
   ipvsctl address add [command options] [arguments...]

OPTIONS:
   --vip value                      Specify vs IP address
   --vport value                    Specify vs port number, range [0-65535] (default: 0)
   --protocol value, --proto value  Specify vs protocol, option [TCP UDP SCTP] (default: TCP)
   --lip value                       Specify vs local address, multiple with separator comma
   --help, -h                       show help (default: false)

Delete Address

Delete local address with specified virtual service.

./ipvsctl address del -h
NAME:
   ipvsctl address del - Delete ipvs local address

USAGE:
   ipvsctl address del [command options] [arguments...]

OPTIONS:
   --vip value                      Specify vs IP address
   --vport value                    Specify vs port number, range [0-65535] (default: 0)
   --protocol value, --proto value  Specify vs protocol, option [TCP UDP SCTP] (default: TCP)
   --lip value                       Specify vs local address, multiple with separator comma
   --help, -h                       show help (default: false)

Flush Address

Flush all the local addresses with specified virtual service.

./ipvsctl address flush -h
NAME:
   ipvsctl address flush - Flush all the local address

USAGE:
   ipvsctl address flush [command options] [arguments...]

OPTIONS:
   --vip value                      Specify vs IP address
   --vport value                    Specify vs port number, range [0-65535] (default: 0)
   --protocol value, --proto value  Specify vs protocol, option [TCP UDP SCTP] (default: TCP)
   --help, -h                       show help (default: false)

Timeout

It's about virtual service connections' timeout values (in seconds) for TCP sessions, TCP sessions after receiving a FIN packet, and UDP packets.

Supported sub-commands show, set.

./ipvsctl timeout -h
NAME:
   ipvsctl timeout - Operates timeout (tcp tcpfin udp)

USAGE:
   ipvsctl timeout command [command options] [arguments...]

COMMANDS:
   show, ls, get  Shows timeout of tcp tcpfin udp
   set, s         Sets timeout of tcp tcpfin udp
   help, h        Shows a list of commands or help for one command

OPTIONS:
   --help, -h  show help (default: false)

Show Timeout

Show the current timeout values.

./ipvsctl timeout show -h
NAME:
   ipvsctl timeout show - Shows timeout of tcp tcpfin udp

USAGE:
   ipvsctl timeout show [command options] [arguments...]

OPTIONS:
   --help, -h  show help (default: false)

Set Timeout

Change timeout values.

./ipvsctl timeout set -h
NAME:
   ipvsctl timeout set - Sets timeout of tcp tcpfin udp

USAGE:
   ipvsctl timeout set [command options] [arguments...]

DESCRIPTION:
   Change the timeout values used for IPVS connections. This command support 3 options, representing  the  timeout   values  (in seconds)  for TCP sessions, TCP sessions after receiving a  FIN packet, and  UDP  packets, respectively. A timeout value 0 means that the current timeout value of the  corresponding  entry  is preserved.

OPTIONS:
   --tcp value, -t value                  set tcp timeout(unit second), 0 means no change (default: 900)
   --tcpfin value, -f value, --fin value  set tcpfin timeout(unit second), 0 means no change (default: 120)
   --udp value, -u value                  set udp timeout(unit second), 0 means no change (default: 300)
   --help, -h                             show help (default: false)

Zero

It's used to clear out all the virtual services' statistics.

./ipvsctl zero -h
NAME:
   ipvsctl zero - Zero ipvs all the virtual service stats(byte packet and rate counters)

USAGE:
   ipvsctl zero [command options] [arguments...]

OPTIONS:
   --yes, --force, -f, -y  Are you agree to do it?[yes/no] (default: false)
   --help, -h              show help (default: false)

Flush

It's used to clear out the virtual server table.

./ipvsctl flush -h
NAME:
   ipvsctl flush - Flush out the virtual server table

USAGE:
   ipvsctl flush [command options] [arguments...]

OPTIONS:
   --yes, --force, -f, -y  Are you agree to do it?[yes/no] (default: false)
   --help, -h              show help (default: false)

Daemon

The connection synchronization daemon is implemented inside the Linux kernel. The master daemon running at the primary load balancer multicasts changes of connections periodically, and the backup daemon running at the backup load balancers receives multicast message and creates corresponding connections. Then, in case the primary load balancer fails, a backup load balancer will takeover, and it has state of almost all connections, so that almost all established connections can continue to access the service.

The sync daemon currently only supports IPv4 connections.

Supported sub-commands show, add, del.

./ipvsctl daemon -h
NAME:
   ipvsctl daemon - Operates daemon

USAGE:
   ipvsctl daemon command [command options] [arguments...]

COMMANDS:
   show, ls, get        Shows daemons of state, sync-id and mcast-interface
   add, a, new, n, set  Add daemon, currently only supports IPv4 connections
   del, d, del          Del daemon
   help, h              Shows a list of commands or help for one command

OPTIONS:
   --help, -h  show help (default: false)

Show Daemon

Show the connection synchronization daemon, like daemon's state, sync-id and mcast-interface.

./ipvsctl daemon show -h
NAME:
   ipvsctl daemon show - Shows daemons of state, sync-id and mcast-interface

USAGE:
   ipvsctl daemon show [command options] [arguments...]

OPTIONS:
   --help, -h  show help (default: false)

Add Daemon

Start the connection synchronization daemon.

./ipvsctl daemon add -h
NAME:
   ipvsctl daemon add - Add daemon, currently only supports IPv4 connections

USAGE:
   ipvsctl daemon add [command options] [arguments...]

OPTIONS:
   --state value      Specify daemon state, option [master backup]
   --sync-id value    Specify daemon syncId (default: 0)
   --mcast-ifn value  Specify daemon mcast-interface
   --help, -h         show help (default: false)

Delete Daemon

Stop the connection synchronization daemon.

./ipvsctl daemon del -h
NAME:
   ipvsctl daemon del - Del daemon

USAGE:
   ipvsctl daemon del [command options] [arguments...]

OPTIONS:
   --state value  Specify daemon state, option [master backup]
   --help, -h     show help (default: false)

Connection

Supported sub-commands show.

Show Connection

Shows current virtual service connections.

./ipvsctl conn show -h
NAME:
   ipvsctl connection show - Shows ip_vs current connection

USAGE:
   ipvsctl connection show [command options] [arguments...]

OPTIONS:
   --vip value             Specify vs IP address
   --vport value           Specify vs port number, range [0-65535] (default: 0)
   --path value, -p value  specify ip_vs connection file path (default: /proc/net/ip_vs_conn)
   --help, -h              show help (default: false)

License

Apache License 2.0

Documentation

Overview

Copyright 2022 kwanhur

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Copyright 2022 kwanhur

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Copyright 2022 kwanhur

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Copyright 2022 kwanhur

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Copyright 2022 kwanhur

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Copyright 2022 kwanhur

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Copyright 2022 kwanhur

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Copyright 2022 kwanhur

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Copyright 2022 kwanhur

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.