xymon - En ligne dans le Cloud

PROGRAMME:

Nom

xymon - programme de communication client Xymon

SYNOPSIS

xymon [choix] BÉNÉFICIAIRE message

DESCRIPTION

xymon(1) est le programme client utilisé pour communiquer avec un serveur Xymon. C'est fréquemment
utilisé par les systèmes clients Xymon pour envoyer des messages d'état et des alertes de téléavertisseur sur les tests locaux.

Dans Xymon, le programme xymon est également utilisé à des fins administratives, par exemple pour renommer ou
supprimer des hôtes ou désactiver les hôtes qui sont indisponibles pendant de longues périodes.

OPTIONS ET PARAMETRES

--déboguer
Activer le débogage. Cela imprime des détails sur la façon dont la connexion au Xymon
serveur est en cours d'établissement.

--proxy=http://PROXYSERVER:PORT PROXY/
Lors de l'envoi des messages d'état via HTTP, utilisez plutôt ce serveur comme proxy HTTP
de se connecter directement au serveur Xymon.

--timeout=N
Spécifie le délai d'expiration pour la connexion au serveur Xymon, en secondes. Le défaut
est de 5 secondes.

--réponse
L'utilitaire xymon sait normalement quand attendre une réponse du serveur, donc cela
l'option n'est pas obligatoire. Cependant, toute réponse du serveur sera
affiché.

--fusionner
Fusionnez le texte du message de ligne de commande avec les données fournies sur l'entrée standard, et
envoyer le résultat au serveur Xymon. Le texte du message fourni sur la ligne de commande
devient la première ligne du message fusionné.

BÉNÉFICIAIRE
La BÉNÉFICIAIRE paramètre définit quel serveur reçoit le message. Si le DESTINATAIRE est
donné comme "0.0.0.0", alors le message est envoyé à tous les serveurs répertoriés dans le
Variable d'environnement XYMSERVERS.

Habituellement, un client utilisera "$XYMSRV" pour le BÉNÉFICIAIRE paramètre, car il s'agit
défini pour que les scripts clients contiennent automatiquement la valeur correcte.

La BÉNÉFICIAIRE le paramètre peut être une URL pour un serveur Web qui a le xymoncgimsg.cgi
ou un script similaire installé. Cela tunnelise les messages Xymon vers le serveur Xymon
en utilisant le protocole HTTP standard. Les xymoncgimsg.cgi(8) Outil CGI (inclus dans Xymon)
doit être installé sur le serveur Web pour que le transport HTTP fonctionne.

MESSAGE
La message est le message à envoyer au serveur Xymon.
Les messages doivent être placés entre guillemets, mais ce faisant, ils peuvent s'étendre sur plusieurs lignes.
La taille maximale d'un message est définie par la longueur maximale autorisée de votre
ligne de commande du shell, et est généralement de 8 à 32 Ko.

Si vous devez envoyer des messages d'état plus longs, vous pouvez spécifier "@" comme message :
xymon lira alors le message d'état à partir de son stdin.

XYMON MESSAGE SYNTAXE

Cette section répertorie les messages les plus couramment utilisés dans le protocole Xymon.

Chaque message doit commencer par l'une des commandes Xymon. Lorsqu'un HOSTNAME est spécifié, il
les points du nom d'hôte doivent être remplacés par des virgules si le paramètre Xymon FQDN est activé
(qui est la valeur par défaut). Ainsi, l'hôte "www.foo.com", par exemple, signalerait comme
"www,foo,com".

status[+LIFETIME][/group:GROUP] HOSTNAME.TESTNAME COLOR
Cela envoie un message d'état pour un seul test (colonne) sur un seul hôte.
TESTNAME est le nom de la colonne où ce test apparaîtra ; n'importe quel nom est valide
sauf que l'utilisation de points dans le nom du test ne fonctionnera pas. La COULEUR doit être l'une des
couleurs valides : "vert", "jaune", "rouge" ou "clair". Les couleurs "bleu" et "violet"
- bien que des couleurs valides - ne doivent pas être envoyées dans un message d'état, car elles sont
géré spécialement par le serveur Xymon. En tant que cas particulier (pour prendre en charge les
clients), "client" peut être utilisé comme nom de la couleur. Cela provoque le statut
message à traiter par Xymon en tant que message de données « client », et le TESTNAME
est utilisé comme "ID de collecteur".
Le "texte supplémentaire" comprend normalement un horodatage local et un résumé du test
résultat sur la première ligne. Toutes les lignes qui suivent la première sont de forme libre et peuvent
inclure toute information pouvant être utile pour diagnostiquer le problème signalé.
La DURÉE DE VIE définit combien de temps ce statut est valide après avoir été reçu par le
Serveur Xymon. La valeur par défaut est de 30 minutes, mais vous pouvez définir la période de votre choix. Par exemple
pour un test personnalisé qui s'exécute une fois par heure, vous voudrez le définir sur au moins 60
minutes - sinon, le statut deviendra violet après 30 minutes. C'est une bonne idée
pour régler la DURÉE DE VIE légèrement plus longue que l'intervalle entre vos tests, pour
permettre des variations dans le temps qu'il faut à votre test pour terminer. La VIE est dans
minutes, sauf si vous ajoutez un "h" (heures), "d" (jours) ou "w" (semaines) immédiatement après
le numéro, par exemple "status+5h" pour un statut valable 5 heures.
L'option GROUP est utilisée pour diriger les alertes du statut vers un groupe spécifique. Ce
est actuellement utilisé pour le statut généré à partir des données des clients Xymon, par exemple pour diriger
alertes pour un statut "procs" à différentes personnes, selon exactement quel processus
est éteint.

notifier HOSTNAME.TESTNAME
Cela déclenche un message d'information à envoyer à ceux qui reçoivent des alertes pour
cette combinaison HOSTNAME+TESTNAME, selon les règles définies dans alertes.cfg(5)
Ceci est utilisé par le enadis.cgi(1) outil pour informer les gens de la désactivation des hôtes
ou activé, mais peut également servir de moyen général de notification des administrateurs de serveur.

données HOSTNAME.DATANAME
Le message "data" permet aux outils d'envoyer des données sur un hôte, sans qu'il apparaisse comme
une colonne sur les pages Web de Xymon. Ceci est utilisé, par exemple, pour rapporter des statistiques
sur un hôte, par exemple des données vmstat, qui ne représentent pas en soi quelque chose qui
a une identité rouge, jaune ou verte. Il est utilisé par les modules bottom-feeder RRD, parmi
autres. Dans Xymon, les messages de données sont traités par défaut uniquement par le xymond_rrd(8)
module. Si vous souhaitez gérer des messages de données à l'aide d'une application externe, vous pouvez
voulez activer le xymond_filestore(8) module pour les messages de données, pour stocker des données-
messages dans un format compatible avec le fonctionnement du démon Big Brother.

désactiver HOSTNAME.TESTNAME DURÉE
Désactive un test spécifique pendant DUREE minutes. Cela entraînera le statut de ce
test pour être répertorié comme "bleu" sur le serveur Xymon, et aucune alerte pour cet hôte/test
sera généré. Si DUREE est donné sous forme de nombre suivi de s/m/h/d, il est
interprété comme étant respectivement en secondes/minutes/heures/jours. Pour désactiver un
testez jusqu'à ce qu'il devienne OK, utilisez "-1" comme DURÉE. Pour désactiver tous les tests pour un
hôte, utilisez un astérisque "*" pour TESTNAME.

activer HOSTNAME.TESTNAME
Réactive un test qui avait été désactivé.

requête HOSTNAME.TESTNAME
Interrogez le serveur Xymon pour connaître le dernier état signalé pour ce test particulier. Si
l'état de l'hôte/du test est connu, la réponse est la première ligne du rapport d'état
- la couleur actuelle sera le premier mot de la ligne. Lignes de texte supplémentaires
qui pourraient être présents sur le message d'état ne peuvent pas être récupérés.
Cela permet à n'importe quel client Xymon de déterminer l'état d'un test particulier, qu'il
il s'agit de l'hôte sur lequel le client s'exécute, d'un autre hôte ou
peut-être le résultat d'un test combiné à partir de plusieurs hôtes gérés par état combo(1)
Cela sera généralement utile aux scripts d'extension client Xymon, qui doivent
déterminer le statut d'autres hôtes, par exemple, pour décider si un
une action de redressement doit être engagée.

config NOM DE FICHIER
Récupérez l'un des fichiers de configuration Xymon sur le serveur. Cette commande permet
un client pour extraire les fichiers du répertoire $XYMONHOME/etc/ sur le serveur, permettant
pour les mises à jour semi-automatiques de la configuration client. Depuis la configuration
sont conçus pour avoir un fichier commun pour la configuration de tous les hôtes dans le
système - et c'est en fait la méthode recommandée pour configurer vos clients - cette
facilite la synchronisation des fichiers de configuration.

déposer HOSTNAME
Supprime toutes les données stockées sur l'hôte HOSTNAME. On suppose que vous avez
déjà supprimé l'hôte du fichier de configuration hosts.cfg.

déposer HOSTNAME TESTNAME
Supprimer les données sur un seul test (colonne).

renommer OLDHOSTNAME NEWHOSTNAME
Renommez toutes les données d'un hôte dont le nom a été modifié. Vous devriez le faire après
changer le nom d'hôte dans le fichier de configuration hosts.cfg.

renommer HOSTNAME OLDTESTNAME NEWTESTNAME
Renommer les données sur un seul test (colonne).

xymondlog NOMHÔTE.NOMTEST
Récupérez le journal d'état Xymon pour un seul test. La première ligne de la réponse
contient une série de champs séparés par une barre verticale :

nom d'hôte Le nom de l'hôte

nom du test Le nom de l'épreuve

Couleur Couleur d'état (vert, jaune, rouge, bleu, transparent, violet)

drapeaux de test Pour les tests de réseau, les drapeaux indiquant les détails du test (utilisés par
xymongène).

dernier changement Horodatage Unix lorsque la couleur d'état a changé pour la dernière fois.

temps de connexion Horodatage Unix lorsque le message de journal a été reçu.

heure de validité Horodatage Unix lorsque le message de journal n'est plus valide (il devient violet à
cette fois).

heure d'acquittement Soit -1, soit l'horodatage Unix lorsqu'un accusé de réception actif expire.

temps de désactivation Soit -1 ou Unix timestamp lorsque l'état n'est plus désactivé.

expéditeur Adresse IP d'où l'état a été reçu.

gâteau Soit -1, soit la valeur du cookie utilisée pour accuser réception d'une alerte.

accusé de réception Vide ou message d'acquittement envoyé lors de l'acquittement de l'état.
Les retours à la ligne, les tuyaux et les barres obliques inverses sont échappés avec une barre oblique inverse de style C.

démerde Vide ou le message envoyé lorsque le statut était désactivé. Newline, pipe-signes
et les barres obliques inverses sont échappées avec une barre oblique inverse, de style C.

Après la première ligne vient le journal d'état complet au format texte brut.

xymondxlog NOMHÔTE.NOMTEST
Récupère une chaîne XML contenant le journal d'état comme avec la commande "xymondlog".

xymondboard [CRITÈRES] [champs = LISTE DES CHAMPS]
Récupère un résumé de l'état de tous les tests connus disponibles pour le démon Xymon.

Par défaut - si aucun CRITÈRE n'est fourni - il renvoie une ligne pour tous les statuts
messages trouvés dans Xymon. Vous pouvez filtrer la réponse par sélection spécifique
page, hôte, test, couleur ou divers autres champs. Le PAGEPATH, NETWORK, HOSTNAME,
Les paramètres TESTNAME et *MSG sont des expressions régulières interprétées compatibles avec Perl ;
le paramètre COLOR accepte plusieurs couleurs séparées par des virgules ; les valeurs *TEMPS
accepter les horodatages d'époque unix. Autres variables identifiées dans xymon-xmh(5) peut également
être utilisé.

Étant donné que la filtration hôte est effectuée avant la filtration test, elle est plus efficace (avec
très grands ensembles de données) pour utiliser PAGEPATH, HOSTNAME, NETWORK et d'autres filtres XMH_
lorsque cela est possible, avant de filtrer globalement avec COLOR, *MSG, *TIME ou TESTNAME.

Vous pouvez filtrer, par exemple, à la fois un nom d'hôte et un nom de test.

page=CHEMIN DE PAGE Inclure uniquement les tests des hôtes trouvés sur la page PAGEPATH dans le
fichier hosts.cfg.

net=RESEAU Inclure uniquement les tests des hôtes avec cette balise NET :

IP=IPAdresse Inclut uniquement les tests des hôtes avec cette adresse IP. Ceci est une expression régulière,
pas CIDR.

hôte=NOM D'HTE Inclure uniquement les tests de l'hôte HOSTNAME

test=NOMTEST Inclure uniquement les tests avec le nom de test TESTNAME

couleur=NOM COULEUR Inclure uniquement les tests dont la couleur d'état est COLORNAME

tag=NOMÉTAG Inclure uniquement les hôtes avec une certaine balise spécifiée dans le hôtes.cfg(5)
ligne. Notez que seuls les éléments connus des composants xymon sont inclus ici ; arbitraire
le texte n'est pas inclus

XMH_string=VALEUR Inclure uniquement les hôtes avec un xymon-xmh(5) variable correspondant à cette
Plus-value

Filtrage avancé

message=MESSAGE N'incluez que les tests dont le contenu correspond au MESSAGE. Utilisez "\s" pour
espaces d'échappement (ou autres chaînes PCRE)

acmsg=MESSAGE N'incluez que les tests avec accusé de réception MESSAGE. Utilisez "\s" pour
espaces d'échappement (ou autres chaînes PCRE)

dismsg=MESSAGE Inclure uniquement les tests qui ont été désactivés avec des chaînes correspondant
UN MESSAGE. Utilisez "\s" pour échapper les espaces (ou d'autres chaînes PCRE). (c'est le plus efficace
pour l'associer à color=blue.)

Filtres d'horodatage

Certains champs (expliqués ci-dessous) peuvent être filtrés avec des horodatages unix et avec le
inégalités suivantes : >= > <= < = !=

Ces filtres sont : lastchange, logtime, validtime, acktime, disabletime

La réponse est une ligne pour chaque statut qui correspond aux CRITÈRES, ou à tous les statuts
si aucun critère n'est spécifié. La ligne est composée d'un certain nombre de champs, séparés
par un tuyau-signe. Vous pouvez sélectionner les champs à récupérer en les listant dans la
LISTE DE CHAMP. Les champs suivants sont disponibles :

nom d'hôte Le nom de l'hôte

nom du test Le nom de l'épreuve

Couleur Couleur d'état (vert, jaune, rouge, bleu, transparent, violet)

drapeaux Pour les tests de réseau, les drapeaux indiquant les détails du test (utilisés par
xymongène).

dernier changement Horodatage Unix lorsque la couleur d'état a changé pour la dernière fois.

temps de connexion Horodatage Unix lorsque le message de journal a été reçu.

heure de validité Horodatage Unix lorsque le message de journal n'est plus valide (il devient violet à
cette fois).

heure d'acquittement Soit -1, soit l'horodatage Unix lorsqu'un accusé de réception actif expire.

temps de désactivation Soit -1 ou Unix timestamp lorsque l'état n'est plus désactivé.

expéditeur Adresse IP d'où l'état a été reçu.

gâteau Soit -1, soit la valeur du cookie utilisée pour accuser réception d'une alerte.

line1 Première ligne du journal d'état.

accusé de réception Vide (si aucun acquittement n'est actif), ou le texte de l'acquittement
par voie électronique.

démerde Vide (si l'état est actuellement activé), ou le texte de la désactivation
par voie électronique.

msg Le texte intégral du message d'état actuel.

client Affiche « Y » si des données client sont disponibles, « N » sinon.

tampon clnt Horodatage de la réception du dernier message client, dans "époque" Unix
le format.

liste d'attente Liste des acquittements en cours pour un test. Il s'agit d'une chaîne de texte avec
plusieurs champs, délimités par un caractère deux-points. Il y a 5 champs : Horodatage pour
quand l'accusé de réception a été généré et quand il expire ; le "niveau ack" ; l'utilisateur qui
envoyé l'accusé de réception ; et le texte de remerciement.

rabatinfo Indique si le statut bat. 5 champs, délimités par "/" : Un "0" si le
l'état ne bat pas et « 1 » s'il bat ; horodatage du dernier statut
le changement a été enregistré et quand le premier changement de statut a été enregistré ; et les deux
couleurs entre lesquelles le statut oscille.

stats Nombre de changements de statut qui ont été enregistrés pour ce statut depuis xymond
a été commencé.

modificateurs Répertorie tous les modificateurs actifs pour ce statut (c'est-à-dire les mises à jour envoyées à l'aide d'un
commande "modifier").

XMH_* Les balises XMH font référence au Xymon hôtes.cfg(5) paramètres de configuration. Plein
la liste de ceux-ci peut être trouvée dans le xymon-xmh(5) page de manuel.

Les champs acmsg, dismsg et msg ont certains caractères encodés : la nouvelle ligne est "\n",
TAB est "\t", le retour chariot est "\r", un signe pipe est "\p", et une barre oblique inverse est "\\".

Si le paramètre "fields" est omis, un ensemble par défaut de
nom d'hôte, nom de test, couleur, drapeaux, dernière modification, heure de connexion, heure de validité, heure d'accusé de réception, heure de désactivation, expéditeur, cookie, ligne1
est utilisé.

xymondxboard
Récupère une chaîne XML avec le résumé de tous les journaux d'état comme pour le
commande "xymondboard".

info hôte [CRITÈRES]
Récupère la configuration actuelle d'un hôte (c'est-à-dire le hôtes.cfg(5) définition).
CRITÈRES sélectionne quel(s) hôte(s) signaler, et est identique aux CRITÈRES dans le
commande xymondboard.

La réponse est une ligne pour chaque hôte qui correspond aux CRITÈRES, ou tous les hôtes si
aucun critère n'est spécifié. La ligne est composée d'un certain nombre de champs, séparés par
un tuyau-signe. Les deux premiers champs seront toujours le nom d'hôte et l'adresse IP.
Les champs restants - le cas échéant - sont les balises hosts.cfg sans ordre particulier.

télécharger FILENAME
Téléchargez un fichier à partir du répertoire de téléchargement du serveur Xymon.

client[/COLLECTORID] HOSTNAME.OSTYPE [HOSTCLASS]
Utilisé pour envoyer un message "client" au serveur Xymon. Les messages clients sont générés
par le client Xymon ; lorsqu'ils sont envoyés au serveur Xymon, ils sont comparés au
règles dans le analyse.cfg(5) fichier de configuration et des messages d'état sont générés
pour les tests côté client. Le COLLECTORID est utilisé lors de l'envoi de données client qui
sont des ajouts aux données client standard. Les données seront concaténées avec le
données client normales.

clientlog NOM D'HÔTE [section=NOM DE SECTION[,NOM DE SECTION...]]
Récupère le dernier message client brut actuel envoyé par HOSTNAME. L'optionnel
Le filtre "section" est utilisé pour sélectionner des sections spécifiques des données client.

ping Tente de contacter le serveur Xymon. En cas de succès, l'ID de version du serveur Xymon est
signalé.

pullclient
Ce message est utilisé lors de la récupération des données client via le mécanisme "pull" mis en œuvre
by xymonfetch(8) ainsi que msgcache(8) pour les clients qui ne peuvent pas se connecter directement au
Serveur Xymon.

liste des fantômes
Signaler une liste de fantôme clients vus par le serveur Xymon. Les fantômes sont des systèmes qui
rapportent les données au serveur Xymon, mais ne sont pas répertoriés dans le fichier hosts.cfg.

programme [TIMESTAMP COMMAND]
Planifie une commande envoyée au serveur Xymon pour une exécution ultérieure. Par exemple
utilisé pour programmer la désactivation d'un hôte ou d'un service à un moment donné dans le futur. COMMANDER
est une commande Xymon complète telle que celles répertoriées ci-dessus. TIMESTAMP est l'Unix
époque à laquelle la commande sera exécutée.
Si aucun paramètre n'est fourni, les tâches actuellement planifiées sont répertoriées dans le
réponse. La réponse est d'une ligne par commande planifiée, avec le job-id, le
l'heure à laquelle la commande sera exécutée, l'adresse IP à partir de laquelle celle-ci a été envoyée,
et la chaîne de commande complète.
Pour annuler une commande précédemment programmée, "calendrier annuler EMPLOI" peut être utilisé.
JOBID est un nombre fourni comme premier élément dans la sortie de la liste de planification.

note NOM DE FICHIER
Le texte du message sera stocké dans $XYMONHOME/notes/FILENAME qui est ensuite utilisé comme
hyperliens à partir de noms d'hôtes ou de noms de colonnes. Cela nécessite que la tâche "storenotes"
est activé dans tasks.cfg (il est désactivé par défaut). FILENAME ne peut pas contenir de
chemin du répertoire - ceux-ci sont supprimés automatiquement.

ID utilisateurmsg
Ces messages seront relayés directement vers les modules d'écoute sur le canal "utilisateur"
du démon Xymon. Ceci est destiné à une communication personnalisée entre le côté client
modules et le serveur Xymon.

modifier HOSTNAME.TESTNAME COULEUR SOURCE CAUSE
Modifier la couleur d'un statut spécifique, sans générer un statut complet
un message. C'est pour les processeurs backend (par exemple les graphiques RRD) qui peuvent remplacer le
couleur d'un statut en fonction de certains critères déterminés en dehors du flux normal d'un
statut. Par exemple, le statut "conn" normal peut sembler être vert car il vérifie simplement
si un hôte peut être ping ou non ; le gestionnaire RRD peut alors utiliser un "modify"
commande pour remplacer ceci est le temps de réponse ping réel dépasse un seuil donné.
(Voir le paramètre de configuration "DS" dans analyse.cfg(5) pour savoir comment faire). LA SOURCE
est une identification du module qui génère le message "modifier" - futur
les modifications doivent utiliser la même source. Il peut y avoir plusieurs sources qui modifient
le même statut (le statut le plus sévère devient alors la couleur réelle du
statut). CAUSE est une chaîne de texte d'une ligne expliquant la raison du remplacement de la
couleur d'état normale - elle sera affichée sur la page Web d'état.

EXEMPLE

Envoyer un message d'état normal au serveur Xymon, en utilisant le protocole Xymon standard sur TCP
port 1984 :
$ $XYMON $XYMSRV "statut www,foo,com.http vert `date` Web OK"

Envoyer le même message d'état, mais en utilisant le protocole HTTP via le xymoncgimsg.cgi du serveur Web
script:
$ $XYMON http://bb.foo.com/cgi-bin/xymoncgimsg.cgi "statut www,foo,com.http vert
`date` Web OK"

Utilisez le message "query" pour déterminer la couleur du test "www", et redémarrez Apache s'il est
rouge:

$ WWW=`$XYMON $XYMSRV "requête www,foo,com.www" | awk '{print $1}'`
$ if [ "$WWW" = "rouge" ]; puis /etc/init.d/apache redémarrer ; Fi

Utilisez le message "config" pour mettre à jour un fichier mytest.cfg local (mais seulement si nous obtenons une réponse) :

$ $XYMON $XYMSRV "config montest.cfg" >/tmp/mytest.cfg.new
$ if [ -s /tmp/mytest.cfg.new ]; alors
mv /tmp/montest.cfg.new $XYMONHOME/etc/montest.cfg
fi

Envoyez un très gros message d'état qui a été construit dans le fichier "statusmsg.txt". Au lieu
de le fournir sur la ligne de commande, passez-le via stdin à la commande xymon :

$ cat statusmsg.txt | $XYMON $XYMSRV "@"

Utiliser xymon en ligne à l'aide des services onworks.net