My favorites | Sign in
Project Home Downloads Wiki Issues Source
Search
for
PTF_Custom_Sensors  
PTF Custom Sensors: Overview of PTF Custom Sensors.
Featured
Updated Mar 28, 2012 by gerard.feijth@gmail.com

On this page you will find an overview of Standard sensors.

The Advanced XML sensors can be found here.

Latest versions:

Sensor Description Version Date PRTG * Download
PassHashToolScramble your password for PTF sensors.1.0.1.221/09/20107.1here
AzureGets the XML result from a Service Management Resource of an Azure account.9.0.508/02/20128.2here
CheckPTFVersionCompares your local PTF custom sensors with the last available versions.8.0.3.112/02/20118.1here
CompareTimeCompares the UTC time of the specified computer with the local UTC time.8.0.1.115/02/20117.1here
ContactStateReturns the state of a dry contact connected to a serial port.8.0.1.122/09/20107.1here
CSVExportExports sensor data to a csv file.8.0.4.103/05/20117.1here
EmailRoundTripPopAlternative email roundtrip sensor.8.0.2.119/04/20117.1here
EventlogReaderGets the value of the most recent event log entry for the given source.9.0.3.421/03/20127.1here
ExternalIPGets the ISP-assigned IP address of the Probe.8.0.1.119/06/20118.2here
HTTPContentChecks for HTTP content changes.8.0.1.117/08/20118.2here
NetworkFileCountReturns the number of files on a \\Server\Share8.0.2.114/10/20107.1here
PingWarningPings a device and goes into a warning state if no reply is received.8.0.1.122/09/20107.1here
PSx64Executes a Powershell script in 64 bit mode.9.0.1.110/02/20128.2here
ReadFileReads a file into memory and returns the number of bytes/sec.8.0.1.107/09/20117.1here
SensorCountCounts your PRTG sensors with a specified state.8.0.2.114/03/20127.1here
SensorStatusReturns a warning state if a sensor state has changed into one of the given statuses.8.0.1.106/03/20118.2here
ServiceStatusRetrieves the status of a Windows service.9.0.1.107/03/20128.2here
USBDevicesReturns the number of connected USB storage devices.9.0.1.108/02/20128.2here

* This is the minimum PRTG version that is required for this sensor

Overview

General

All Custom Sensors listed target the .Net Framework 2.0. (unless stated otherwise)

Copy the .exe file to the "\Custom Sensors\EXE" folder of your PRTG Network Monitor installation. You can manually launch the .exe for an explanation of the parameters required


PassHashTool

Summary

This tool can be used in combination with PTF sensors that require a users password to be entered in the sensors settings section. The PassHash can be used instead off the given password. details

back to top

Version history

1.0.1.2 21/09/2010

  • First public version

Azure

Summary

This sensor Gets the XML result from a Service Management Resource of an Azure account.

-u=https://management.core.windows.net/<subscriptionId> -cn=certificatename -n=nodename [-t=xx] [-un=username] [-pw=password] [-ssl3] [-c] [-cc] [-cs] [-rm=,] [-cm="My custom message"]

-u=    The url that returns the xml document.
-cn=   The name of the certificate to use.
-n=    The name of the xml node to check.
-t=    Optional the number of seconds to wait for a responce from the server (default = 15 sec).
-un=   Optional username to authenticate the http connection.
-pw=   Optional password to authenticate the http connection.
-ssl3  Optional switch to force a ssl3 connection.
-c     Optional switch to count the number of occurrences of the xml node.
-cc    Optional switch to count the number of childnodes of the xml node.
-cs    Optional switch to count the number of sibbelings of the xml node.
-rc=   Optional the characters to remove from the xml value (i.e. to remove a thousands seperator from the result use -rc=,)
-cm=   Optional a custom message to be displayed (i.e. -cm="There are %1 tickets in our ticketing system." where %1 will be replaced with the xml value).
-ps=   Optional proxyserver to use connecting to the internet.
-pu=   Optional doamin\user to connect to your proxyserver.
-pp=   Optional password or passhash * to connect to your proxyserver.

Click here for an explanation of the URL's that can be used addressing the Azure Service Management Resources:

Note: The certificate is the only means of authentication, if the wrong (type off) certificate is used or it is not correctly installed in the right store (there are some checks performed by the sensor of cause) the Azure server returns a “403 unauthorized”. The GenCert tool can help you generating and installing a valid certificate.

back to top

Version history

9.0.5.1 08/02/2012

  • First public version

CheckPTFVersion

Summary

This sensor compares your local PTF custom sensors with the last available versions.

This sensor requires no parameters!

back to top

Version history

8.0.3.1 12/02/2011

  • New: added support for EXE/XML sensors.

8.0.2.1 17/10/2010

  • Bugfix: The sensor did not report an update of the MediaStream sensor as that one is published as MediaStreamer.

8.0.1.1 04/10/2010

  • First public version

CompareTime

Summary

This sensor compares the UTC time of the specified computer with the local UTC time.

-c=computer        The ip-address or hostname of the computer to get the UTC time from.
-u=username        Optional the name of the user account that has access to the computer via WMI service.
-p=password        Optional the password or passhash(*) of the user account that has access to the computer via WMI service.
back to top

Version history

8.0.1.1 15/02/2011

  • First public version

ContactState

Summary

This sensor monitors the state of a dry contact connected to a serial port. More details

-s=SerialPort -p=PinNumber [-om=OpenMessage] [-cm=ClosedMessage]
back to top

Version history

8.0.1.1 22/09/2010

  • Compiled for PRTG 8.1

CSVExport

Summary

This sensor exports the data of a sensor to a .csv or .xml file. More details

-pu=demo -pp=demodemo -ps=https://prtg.paessler.com -s=2008
back to top

Version history

8.0.4.1 04/05/2011

  • Bugfix: -av= parameter was not working as expected.
  • Bugfix: in some situations the separator used in the last line of a CSV file could differ from the other lines.

8.0.3.1 19/04/2011

  • New: added parameter -av= Average interval in seconds; use 0 to download raw data (= results of all single monitoring requests)

8.0.2.1 04/04/2011

  • New: added parameter -ssl3 to force a ssl3 connection to your PRTG server.

8.0.1.1 22/09/2010

  • Compiled for PRTG 8.1

EmailRoundTrip

Summary

This Custom Sensor sends an email using your local email server to a roundtrip address and reports the time it takes for the email to return.

Enter the credentials (username and password), emailserver and other settings in the Parameters section of the Sensor Settings:

-to=  Address to send the mail to.
-fr=  From address of the mail to send.
-u=   Username of the mailbox to check for incomming mail.
-p=   Password or PassHash * of the mailbox to check for incomming mail.
-s=   Mailserver for sending and receiving emails.
-pp=  Optional mailserver POP port. If omitted port 110 is used as default.
-sp=  Optional mailserver SMTP port. If omitted port 25 is used as default.
-ssl  Optional use a ssl connection to connect to your mailserver.
-t=   Optional timeout in seconds. If omitted a timeout of 10 seconds is used as default.

How does this sensor differ from PRTG's own email roundtrip sensor?

  • This sensor does not have to wait for the email to return, but processes the received email from the previous run of the sensor.
  • Fast response times, freeing up resources more quickly.
  • Roundtrip time is calculated by examining the email headers.
  • “Missed” email responses that come in to late are automatically deleted, keeping the users mailbox cleaned up.
  • The unique identifier is not in the email subject but in the email header, reducing the chance of the email getting caught by a spam filter.
back to top

Version history

8.0.2.1 19/04/2011

  • First public version

EventlogReader

Summary

This Custom Sensor gets the value of the most recent event log entry for the given source.

Enter the machinename, eventlog and source in the Parameters section of the Sensor Settings:

-c=   The ip-address or hostname of the computer hosting the eventlog.
-e=   The name of the eventlog.
-s=   The name of the eventlog source.
-u=   Optional, Domain\Username of a user account that can access the (remote) eventlog.
-p=   Optional, Password or PassHash * of a user account that can access the (remote) eventlog.
-m=   Optional, the maximum time in minutes a result is allowed to be old.
      default = 1 day (1440 minutes)
-t=   Optional, The EntryTypes to report on.
      Error=1, Warning=2, Information=4, SuccessAudit=8, FailureAdit=16 (default = 31)
      To report on Error AND Warning use -t=3

The download also includes the EventlogReader.msg file. See also: Why do I need the EventlogReader.msg file

back to top

Version history

9.0.3.4 21/03/2012

  • New: Added parameter -t= to only report on given EntryTypes.

9.0.2.1 17/12/2011

  • Bugfix: Targeting the localhost resulted into an error.
  • Changed: Both the long (Microsoft-Windows-Backup) and short (Backup) source names can now be used.
  • New: Added support for non existing message DLL's on the Probe system. See also: Why do I need the EventlogReader.msg file

9.0.1.1 14/12/2011

  • First public version

ExternalIP

Summary

This Custom Sensor gets the ISP-assigned IP address of the Probe.

This sensor requires no parameters.

back to top

Version history

8.0.1.1 19/06/2011

  • First public version

HTTPContent

Summary

This Custom Sensor Checks for HTTP content changes. If the content has changed from the previous run of the sensor, the sensor returns the value 1 else the sensor returns the value 0

Enter the url and optional proxy settings in the Parameters section of the Sensor Settings:

-u=    The url to check.
-ps=   Optional proxyserver to use connecting to the internet.
-pd=   Optional proxydomain domain name to connect to your proxyserver.
-pu=   Optional proxyuser to connect to your proxyserver.
-pp=   Optional proxypassword or passhash * to connect to your proxyserver.    
back to top

Version history

8.0.1.1 17/08/2011

  • First public version

LogfileReader

Summary

This Custom Sensor returns whether a specified string occurs in a (log) file. The last occurrence is remembered, so if a new entry is made with the specified string, the sensor will recognize the new entry.

Enter the credentials (username and password), filename and searchstring in the Parameters section of the Sensor Settings:

-u=username -p=password|passhash -f="c:\file location\log.txt" -s="String to search"
back to top

Version history

8.0.1.1 22/09/2010

  • Compiled for PRTG 8.1

NetworkFileCount

Summary

This Custom Sensor returns the number of files available on a server\share. As your PRTG server runs under the local system account it can't access files on a \\server\share. This sensor uses the given username and password of a valid user account that can access the files and returns the number of files.

Enter the credentials (username and password), folder (and optional search filter and setting to also search the sub folders) in the Parameters section of the Sensor Settings:

-f=\\myserver\myshare [-u=username] [-p=password|passhash]  [-s=*.exe] [-sub] [-t=10] [-tiw]

-f=folder          The name of the folder that needs to be checked in a \\server\share format. If the foldername contains white spaces, enter the foldername between " ".
-u=username        Optional the name of the user account that can access the share.
-p=password        Optional the password or passhash(*) of the user account that can access the share.
-t=timedelta       Optional the minimum number of minutes a file has to be old before it is counted.	
-s=searchpattern   Optional the search pattern to be used (i.e. *.txt).
-sub               Optional switch to include subfolders.
-tiw               Optional, in combination with the -t= parameter, creates a time window between the current time and xx minutes ago. Only files created in that period are counted.
back to top

Version history

8.0.1.1 22/09/2010

  • Compiled for PRTG 8.1

PingWarning

Summary

Pings a device and goes into a warning state if no reply is received.

ip-address|hostname [-w=timeout] [-l=size] [-i=TTL]

 
-w=   timeout in miliseconds to wait for a reply, default = 500
-l=   send buffer size, default = 32
-i=   Time To Live, default = 64   
back to top

Version history

8.0.1.1 22/09/2010

  • First public version

PSx64

Summary

Executes a Powershell script in 64 bit mode

-f=filename

-f=    Filename of the powershell script to execute.
back to top

Version history

9.0.1.1 10/02/2012

  • First public version

ReadFile

Summary

Reads a file into memory and returns the number of bytes/sec.

-f=file [-u=username] [-p=password]

-f=     The file to read.
-u=     Optional domain\user to read the file.
-p=     Optional password or passhash * to read the file.
back to top

Version history

8.0.1.1 07/09/2011

  • First public version

SensorCount

Summary

This sensor counts the number of sensors on your PRTG server.

-s=192.168.1.1 -u=username -p=password|passhash [-ssl3] [-r=rootID]

Combine any of the following parameters

-u    count up sensors
-d    count down sensors
-a    count acknowledged down sensors
-w    count warning sensors
-n    count unusual sensors
-p    count paused sensors
-k    count unknown sensors
back to top

Version history

8.0.2.1 14/03/2012

  • New: Added parameter -ssl3 for PRTG servers that require a ssl3 connection.

8.0.1.1 22/09/2010

  • Compiled for PRTG 8.1

SensorStatus

Summary

This sensor returns a warning state if a sensor state has changed into one of the given statuses.

-u=username -p=password|passhash [-s=statusses] [-r=rootID]

-u=		PRTG Username.
-p=		PRTG Password.
-s=		Optional, comma seperated list of statuses to monitor (default=7,12,13  'Paused by user', 'Paused "until' and 'Down Acknowledged'.
-r=		Optional, the rootID of the probe or group you want to monitor (default = 0).
back to top

Version history

8.0.1.1 06/03/2011

  • First public version

ServiceStatus

Summary

Retrieves the status of a Windows service and returns a value, where

1=Stopped, 2=StartPending, 3=StopPending, 4=Running, 5=ContinuePending, 6=PausedPending, 7=Paused
-s=servicename [-m=machinename] [-u=username] [-p=password|passhash] [-w=warningstatusses] [-e=errorstatusses]

-s=   Name of the service to check.
-m=   Optional, name or ip of the machine where the service is installed. Default = localhost.
-u=   Optional Domain\Username of a user account that can access the service status.
-p=   Optional Password or passhash * of a user account that can access the service status.
-w=   Optional, comma seperated list of service statusses that will set your sensor in a warning state.
-e=   Optional, comma seperated list of service statusses that will set your sensor in an error state.
back to top

Version history

9.0.1.1 07/03/2012

  • First public version

USBDevices

Summary

This sensor returns the number of connected USB storage devices. Using limits you can get notified when a user plugges in a USB storage device.

-c=computer [-u=username] [-p=password|passhash]

-c=        The ip-address or hostname of the computer to get the number of connected USB storage devices from.
-u=        Optional the name of the user account that has access to the computer via WMI service.
-p=        Optional the password or passhash(*) of the user account that has access to the computer via WMI service.
back to top

Version history

9.0.1.1 08/02/2012

  • First public version

Powered by Google Project Hosting