croneval.asciidoc 1.4 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556
  1. [role="xpack"]
  2. [testenv="gold+"]
  3. [[elasticsearch-croneval]]
  4. == elasticsearch-croneval
  5. Validates and evaluates a cron expression.
  6. [discrete]
  7. === Synopsis
  8. [source,shell]
  9. --------------------------------------------------
  10. bin/elasticsearch-croneval <expression>
  11. [-c, --count <integer>] [-h, --help]
  12. ([-s, --silent] | [-v, --verbose])
  13. --------------------------------------------------
  14. [discrete]
  15. === Description
  16. This command enables you to verify that your
  17. https://en.wikipedia.org/wiki/Cron[cron] expressions are valid for use with the
  18. {es} {alert-features} and produce the expected results.
  19. This command is provided in the `$ES_HOME/bin` directory.
  20. [discrete]
  21. === Parameters
  22. `-c, --count` <Integer>::
  23. The number of future times this expression will be triggered. The default
  24. value is `10`.
  25. `-d, --detail`::
  26. Shows detail for invalid cron expression. It will print the stacktrace if the
  27. expression is not valid.
  28. `-h, --help`::
  29. Returns all of the command parameters.
  30. `-s, --silent`::
  31. Shows minimal output.
  32. `-v, --verbose`::
  33. Shows verbose output.
  34. [discrete]
  35. === Examples
  36. If the cron expression is valid, the following command displays the next
  37. 20 times that the schedule will be triggered:
  38. [source,bash]
  39. --------------------------------------------------
  40. bin/elasticsearch-croneval "0 0/1 * * * ?" -c 20
  41. --------------------------------------------------