softflowctl.8 3.1 KB

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