go-xymon-client

command module
v1.0.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Sep 21, 2023 License: Unlicense Imports: 7 Imported by: 0

README

go-xymon-client

A client for xymon wrote for golang.

See usage in /client/client.go.

This small client have only 4 verbs created:

  • ping
  • query
  • status
  • event (This should be for now (9th of december, 2017) not available on your xymon. This coming from a fork not yet merged)

No other verbs will be created, if you want more pull requests are accepted.

This client is also followed by a simple cli program.

Cli

NAME:
   go-xymon-client - A simple cli program to make request on a xymon

USAGE:
   go-xymon-client [global options] command [command options] [arguments...]

VERSION:
   1.1.0

COMMANDS:
     status, q  Send a test (to update or create it) to your xymon
     query, s   Get the current status of a test
     ping, p    Ping your xymon
     event, e   Send test of type event (may not be available in your xymon)
     help, h    Shows a list of commands or help for one command

GLOBAL OPTIONS:
   --target value, -t value  Target your xymon, e.g: 127.0.0.1:1984 [$XYMON_HOST]
   --no-fqdn                 Do not using fqdn
   --help, -h                show help
   --version, -v             print the version

ping

NAME:
   go-xymon-client ping - Ping your xymon

USAGE:
   go-xymon-client ping

query

NAME:
   go-xymon-client query - Get the current status of a test

USAGE:
   go-xymon-client query [command options] [arguments...]

OPTIONS:
   --host value, -x value   Host of your test
   --name value, -n value   Name of your test
   --group value, -g value  The associate group to your test (optional)

status

NAME:
   go-xymon-client status - Send a test (to update or create it) to your xymon

USAGE:
   go-xymon-client status [command options] [arguments...]

OPTIONS:
   --color value, -c value     Color for your test, can be: clear, green, red, yellow, purple or blue
   --host value, -h value      Host of your test
   --name value, -n value      Name of your test
   --text value, -t value      Message to pass in your test
   --group value, -g value     Associate a group to your test (optional)
   --lifetime value, -l value  Set the expiration time of your test (optional) (add "h" (hours), "d" (days) or "w" (weeks) immediately after the number to use instead of minute)

event

This should be for now (9th of december, 2017) not available on your xymon. This coming from a fork not yet merged

NAME:
   go-xymon-client event - Send test of type event (may not be available in your xymon)

USAGE:
   go-xymon-client event [command options] [arguments...]

OPTIONS:
   --host value, -x value           Host of your test
   --name value, -n value           Name of your test
   --text value, -t value           Message to pass in your test
   --id value, -i value             Id of your event
   --color value, -c value          Color for your event, can be: clear, green, red, yellow, purple or blue
   --activation value, -a value     When event will be activated (default: 0s)
   --ephemeral, -e                  set to true to say that event can be destroyed
   --order value, -o value          optional, set priority event on others (default: 0)
   --default, -d                    if set to true this will be the default event
   --remove, --rm                   if set to true this will remove the event
   --expiration value, --exp value  optional, if set event will be removed at that time (default: 0s)
   --time-location value, -l value  optional, set timezone location to create time format

Documentation

The Go Gopher

There is no documentation for this package.

Directories

Path Synopsis
clientfakes
Code generated by counterfeiter.
Code generated by counterfeiter.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL