---
name: "xymond_sample"
section: "8"
platform: "linux"
package: "xymon"
version: "4.3.30-4"
release: "Debian 13 (Trixie)"
platforms: ["linux"]
url: "https://new.carta.tech/xymond_sample"
---

# xymond\_sample(8)

example of a xymond worker module

## NAME

xymond\_sample - example of a xymond worker module

## SYNOPSIS

**xymond\_channel --channel=status xymond\_sample \[options\]**

## DESCRIPTION

xymond\_sample is a worker module for xymond, and as such it is normally run via the *[xymond\_channel(8)](/xymond_channel/8.md)* program. It receives messages from xymond via stdin, and simply displays these on stdout. It can be used with all types of xymond channels.

xymond\_sample is not designed to actually run, except as a demonstration. The purpose of this tool is to show how xymond worker modules can be implemented to handle different tasks that need to hook into the xymond processing.

## OPTIONS

- \--timeout=N

  Read messages with a timeout of N seconds.

- \--debug

  Enable debugging output.

## SEE ALSO

[xymond\_channel(8)](/xymond_channel/8.md), [xymond(8)](/xymond/8.md), [xymon(7)](/xymon/7.md)