softflowctl.8 3.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100
  1. .\" $Id$
  2. .\"
  3. .\" Copyright (c) 2002 Damien Miller. All rights reserved.
  4. .\"
  5. .\" Redistribution and use in source and binary forms, with or without
  6. .\" modification, are permitted provided that the following conditions
  7. .\" are met:
  8. .\" 1. Redistributions of source code must retain the above copyright
  9. .\" notice, this list of conditions and the following disclaimer.
  10. .\" 2. Redistributions in binary form must reproduce the above copyright
  11. .\" notice, this list of conditions and the following disclaimer in the
  12. .\" documentation and/or other materials provided with the distribution.
  13. .\"
  14. .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
  15. .\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  16. .\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  17. .\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
  18. .\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  19. .\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  20. .\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  21. .\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  22. .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  23. .\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  24. .\"
  25. .Dd October 18, 2002
  26. .Dt SOFTFLOWCTL 8
  27. .Os
  28. .Sh NAME
  29. .Nm softflowctl
  30. .Nd Remote control program for softflowd
  31. .Sh SYNOPSIS
  32. .Nm softflowctl
  33. .Op Fl h
  34. .Op Fl c Ar ctl_sock
  35. .Ar command
  36. .Sh DESCRIPTION
  37. .Nm
  38. is a remote control program used to control a running
  39. .Xr softflowd 8
  40. daemon.
  41. .Pp
  42. The command line options are as follows:
  43. .Bl -tag -width Ds
  44. .It Fl c Ar ctlsock
  45. Specify an alternate location for the remote control socket.
  46. Default is
  47. .Pa /var/run/softflowd.ctl
  48. .It Fl h
  49. Display command line usage information.
  50. .El
  51. .Pp
  52. .Sh COMMANDS
  53. .Bl -tag -width Ds
  54. .It Pa shutdown
  55. Ask
  56. .Xr softflowd 8
  57. to gracefully exit.
  58. This is equivalent to sending it a
  59. .Dv SIGTERM
  60. or
  61. .Dv SIGINT .
  62. .It Pa exit
  63. Ask
  64. .Xr softflowd 8
  65. to immediately exit.
  66. No flow expiry processing or data export is performed.
  67. .It Pa expire-all
  68. Immediately expire all tracked flows.
  69. .It Pa delete-all
  70. Immediately delete all tracked flows.
  71. No flow expiry processing or data export is performed.
  72. .It Pa statistics
  73. Return statistics collected by
  74. .Xr softflowd 8
  75. on expired flows.
  76. .It Pa debug+
  77. Increase the debugging level of
  78. .Xr softflowd 8
  79. .It Pa debug-
  80. Decrease the debugging level.
  81. .It Pa stop-gather
  82. Stops network data collection by
  83. .Xr softflowd 8 .
  84. .It Pa start-gather
  85. Resumes network data collection.
  86. .It Pa dump-flows
  87. Return information on all tracked flows.
  88. .It Pa timeouts
  89. Print information on flow timeout parameters.
  90. .It Pa send-template
  91. Resend a NetFlow v.9 template record before the next flow export.
  92. Has no effect for other flow export versions.
  93. .El
  94. .Sh BUGS
  95. All times are unconditionally displayed in UTC, regardless of the system
  96. timezone.
  97. .Sh AUTHORS
  98. .An Damien Miller Aq djm@mindrot.org
  99. .Sh SEE ALSO
  100. .Xr softflowd 8