[Xymon] xymon-powershell.ps1

Beck, Zak zak.beck at accenture.com
Thu Jun 29 15:15:50 CEST 2017


Group colour is the overall status of the test.

For example, I may have a test that contains multiple tests, like checking the size of two or three directories. Each of those directories may have a red / yellow / green status. The group colour is the overall outer status, for example, if any one of the directory tests has a red status, I may want the group colour to be red.

This is the example of the content of the file, between the markers ---8<---


green 14/01/2016 14:37:07 SERVER1

&green checking directory extdirtest 'c:\temp' - Rules are <50 and <100 - Actually 5 file(s)

In this case:

MESSAGE = 14/01/2016 14:37:07 SERVER1… all the way to the end.

Because it’s a file, the MESSAGE content is taken verbatim – there is no escaping or quoting necessary. The date and time and server name seen in the example are just part of the message, they are not parsed and are not mandatory – they will be displayed on the test’s page.

The name of the test is the name of the file.


From: Steve Brown [mailto:sgb at pics.com]
Sent: 29 June 2017 14:02
To: Beck, Zak <zak.beck at accenture.com>; David Boyer <davieb at gmail.com>
Cc: xymon at xymon.com
Subject: [External] RE: [Xymon] xymon-powershell.ps1

Thanks. I reviewed that yesterday but I didn’t see an example that would be useful. I don’t know what <GROUPCOLOUR> represents. The documentation shows GROUPCOLOUR – red, yellow or green – the colour for the group  But that doesn’t tell me what it represents either.  I don’t know what group it refers to. Does it just mean the status of the test? I’m not using BBWin and have never used it. I was trying to use the xymon-powershell.ps1 script but it seems limited. I’m not a windows person. I’m a Linux guy and was hoping to see an example of this file that would be useful. I was hoping to see the criteria for quoting and different lines. I’ll need to create an example to submit to get permissions to install the Powershell Client and to write files on the server.

From: Beck, Zak [mailto:zak.beck at accenture.com]
Sent: Thursday, June 29, 2017 7:50 AM
To: Steve Brown <sgb at pics.com<mailto:sgb at pics.com>>; David Boyer <davieb at gmail.com<mailto:davieb at gmail.com>>
Cc: xymon at xymon.com<mailto:xymon at xymon.com>
Subject: RE: [Xymon] xymon-powershell.ps1


There’s a section in the doc file for XymonPSClient headed “External data” which describes the file in detail.

Here’s a copy / paste of the format from that section:


GROUPCOLOUR – red, yellow or green – the colour for the group

+LIFETIME – optional – how long before Xymon should turn the status purple if no further results are received, specified in minutes (but supports 'h', 'd' or 'w' suffix e.g. 5h for 5 hours)

MESSAGE  - the message to be displayed. This message can span multiple lines and can include “&colour” e.g. &green / &yellow / &red to display a subtest with the corresponding coloured GIF.

For example, the external script fsmon supplied with the BBWin source writes external files with the following contents:

green 14/01/2016 14:37:07 [SERVER1]

&green checking directory extdirtest 'c:\temp' - Rules are <50 and <100 - Actually 5 file(s)

Here the group colour is green and the subtest colour is also green, no lifetime has been specified so the result will turn purple after the default interval if no more test results are sent.

Note that you can also do this with BBWin if that’s what you’re using, and the message can include html as per your requirement.



From: Steve Brown [mailto:sgb at pics.com]
Sent: 29 June 2017 13:22
To: David Boyer <davieb at gmail.com<mailto:davieb at gmail.com>>; Beck, Zak <zak.beck at accenture.com<mailto:zak.beck at accenture.com>>
Cc: xymon at xymon.com<mailto:xymon at xymon.com>
Subject: [External] RE: [Xymon] xymon-powershell.ps1

Thanks I’ll see if I can get permission to install the PowerShell client and create files on the client machine.  Can you send me an example of the file you place in c:\..\..\tmp ?

From: David Boyer [mailto:davieb at gmail.com]
Sent: Wednesday, June 28, 2017 10:24 PM
To: Beck, Zak <zak.beck at accenture.com<mailto:zak.beck at accenture.com>>
Cc: Steve Brown <sgb at pics.com<mailto:sgb at pics.com>>; xymon at xymon.com<mailto:xymon at xymon.com>
Subject: Re: [Xymon] xymon-powershell.ps1

Like Zak said, just write your HTML page to a file then place it in the c:\..\..\tmp and it should be picked up within 5mins. The filename will reflect the test name on the xymon web page. I have a couple of sched tasks that work this way.

On Wed, Jun 28, 2017 at 5:06 AM, Beck, Zak <zak.beck at accenture.com<mailto:zak.beck at accenture.com>> wrote:

I’m not familiar with xymon-powershell.ps1, but I don’t see why not, the server certainly supports it (we do it all the time in the Powershell client).

Bear in mind for powershell, the escape character for those double-quotes is backtick (`), as in:

"<table width=`"100%`">"

You may want to switch to the Windows Powershell client, it allows you to schedule and run external scripts or pick up data from external text files, so whatever is calling xymon-powershell.ps1 could just write a text file in the correct format to c:\program files\xymon\tmp and it would get sent…




From: Xymon [mailto:xymon-bounces at xymon.com<mailto:xymon-bounces at xymon.com>] On Behalf Of Steve Brown
Sent: 27 June 2017 17:16
To: 'xymon at xymon.com<mailto:xymon at xymon.com>' <xymon at xymon.com<mailto:xymon at xymon.com>>
Subject: [External] [Xymon] xymon-powershell.ps1

Is there a way to send an html table through the xymon-powershell.ps1 script?

I currently use bb-central where I have a Linux script that runs on the xymon server. I’m able to send the html table with the following

OBJFILE="<iframe name=\"locktbl\" src=\"/hobbit/dba/${RHOST}/${MNAME}-lock.html\" frameborder=\"no\" height=\"600\" width=\"1200\"></iframe>"
        ${OBJFILE} "

The status line is very similar to the xymon-powershell.ps1 input

powershell -file xymon-powershell.ps1 %XYMSRV% "status %COMPUTERNAME%.mytest green %DATE% %TIME%" "The status of 'mytest' is 'satisfactory' at %DATE% %TIME%" "" "here's the last line"

I basically want to replace the "The status of 'mytest' is 'satisfactory' at %DATE% %TIME%" with an html table.

Thank you for your help


This message is for the designated recipient only and may contain privileged, proprietary, or otherwise confidential information. If you have received it in error, please notify the sender immediately and delete the original. Any other use of the e-mail by you is prohibited. Where allowed by local law, electronic communications with Accenture and its affiliates, including e-mail and instant messaging (including content), may be scanned by our systems for the purposes of information security and assessment of internal compliance with Accenture policy.


Xymon mailing list
Xymon at xymon.com<mailto:Xymon at xymon.com>

-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.xymon.com/pipermail/xymon/attachments/20170629/db31807b/attachment.html>

More information about the Xymon mailing list