PrtgSensorHistoricData + Uptime

Author: sandersjds

prtgshell2.cs

@@ -0,0 +1,59 @@
+
+function Get-PrtgSensorHistoricData {
+	<#
+	.SYNOPSIS
+		Returns historic data from a specified time period from a sensor object.
+	.DESCRIPTION
+		Returns a table of data using the specified start and end dates and the specified interval.
+	.PARAMETER SensorId
+		The sensor to retrieve data for.
+	.PARAMETER RangeStart
+		DateTime object specifying the start of the history range.
+	.PARAMETER RangeEnd
+		DateTime object specifying the End of the history range.
+	.PARAMETER IntervalInSeconds
+		The minimum interval to include, in seconds. The default is one hour (3600 seconds). A value of zero (0) will return raw data. 
+	.EXAMPLE
+		Get-PrtgSensorHistoricData 2321 (Get-Date "2016-06-23 12:15") (Get-Date "2016-06-23 16:15") 60
+	#>
+
+	[CmdletBinding()]
+    Param (
+        [Parameter(Mandatory=$True,Position=0)]
+        [int] $SensorId,
+
+		[Parameter(Mandatory=$True,Position=1)]
+		[datetime] $RangeStart,
+		
+		[Parameter(Mandatory=$True,Position=2)]
+		[datetime] $RangeEnd,
+		
+		[Parameter(Mandatory=$True,Position=3)]
+		[int] $IntervalInSeconds = 3600
+    )
+
+    BEGIN {
+		$PrtgServerObject = $Global:PrtgServerObject
+    }
+
+    PROCESS {
+		$Parameters = @{
+			"id" = $SensorId
+			"sdate" = $RangeStart.ToString("yyyy-MM-dd-HH-mm-ss")
+			"edate" = $RangeEnd.ToString("yyyy-MM-dd-HH-mm-ss")
+			"avg" = $IntervalInSeconds
+		}
+		
+		$url = $PrtgServerObject.UrlBuilder("api/historicdata.csv",$Parameters)
+		
+		$QueryObject = $PrtgServerObject.HttpQuery($url,$false)
+		
+		$DataPoints = $QueryObject.RawData | ConvertFrom-Csv | ? { $_.'Date Time' -ne 'Averages' }
+		
+		#$APropertyName = (($DataPoints | Get-Member -MemberType NoteProperty | Select-Object -ExpandProperty Name) -notmatch "Coverage") -notmatch "Date Time" | Select-Object -First 1
+	}
+	
+	END {
+		return $DataPoints
+    }
+}

prtgshell2.dll

@@ -0,0 +1,65 @@
+
+# optional thing to add here:
+# make it so we can define a target month in this report, rather than manually specifying the start and end date.
+
+
+function Get-PrtgSensorUptime {
+	<#
+	.SYNOPSIS
+		Returns five-nines-style uptime for a specified time period from a sensor object.
+	.DESCRIPTION
+		Returns five-nines-style uptime for a specified time period from a sensor object.
+	.PARAMETER SensorId
+		The sensor to retrieve data for.
+	.PARAMETER RangeStart
+		DateTime object specifying the start of the history range.
+	.PARAMETER RangeEnd
+		DateTime object specifying the End of the history range.
+	.EXAMPLE
+		 Get-PrtgSensorUptime 2321 (Get-Date "2016-06-23 12:15") (Get-Date "2016-06-23 16:15")
+	#>
+
+	[CmdletBinding()]
+    Param (
+        [Parameter(Mandatory=$true,Position=0)]
+        [int] $SensorId,
+
+		[Parameter(Mandatory=$true,Position=1)]
+		[datetime] $RangeStart,
+		
+		[Parameter(Mandatory=$false,Position=2)]
+		[datetime] $RangeEnd		
+    )
+
+    BEGIN {
+		$PrtgServerObject = $Global:PrtgServerObject
+		
+		if (!$RangeEnd) {
+			$RangeStart = Get-Date ($RangeStart.ToString('MMMM yyyy'))
+			$RangeEnd = $RangeStart.AddMonths(1).AddSeconds(-1)
+		}
+    }
+
+    PROCESS {
+		$HistoricData = Get-PrtgSensorHistoricData $SensorId $RangeStart $RangeEnd 0
+		
+		$APropertyName = (($HistoricData | Get-Member -MemberType NoteProperty | Select-Object -ExpandProperty Name) -notmatch "Coverage") -notmatch "Date Time" | Select-Object -First 1
+		
+		# maybe this is valid?
+		$UpEntries = $HistoricData.$APropertyName | ? { $_ -ne "" }
+		
+	}
+	
+	END {
+		$returnobject = "" | select SensorId,RangeStart,RangeEnd,TotalDatapoints,UpDatapoints,DownDatapoints,UptimePercentage
+		$returnobject.SensorId = $SensorId
+		$returnobject.RangeStart = $RangeStart
+		$returnobject.RangeEnd = $RangeEnd
+		$returnobject.TotalDatapoints = $HistoricData.Count
+		$returnobject.UpDatapoints = $UpEntries.Count
+		$returnobject.DownDatapoints = $HistoricData.Count - $UpEntries.Count
+		$returnobject.UptimePercentage = ($UpEntries.Count / $HistoricData.Count) * 100
+		
+		return $returnobject
+    }
+}

prtgshell2.psd1

@@ -46,6 +46,7 @@ function Get-PrtgServer {
 		When specified, the cmdlet returns nothing on success.
 	#>
 
+	[CmdletBinding()]
 	Param (
 		[Parameter(Mandatory=$True,Position=0)]
 		[ValidatePattern("\d+\.\d+\.\d+\.\d+|(\w\.)+\w")]
@@ -70,50 +71,68 @@ function Get-PrtgServer {
 	)
 
     BEGIN {
+		
+		$PrtgServerObject = New-Object PrtgShell.PrtgServer
+		
+		$PrtgServerObject.Server   = $Server
+		$PrtgServerObject.UserName = $UserName
+		$PrtgServerObject.PassHash = $PassHash
+		
 		if ($HttpOnly) {
 			$Protocol = "http"
 			if (!$Port) { $Port = 80 }
+			
 		} else {
 			$Protocol = "https"
 			if (!$Port) { $Port = 443 }
 
-			$PrtgServerObject = New-Object PrtgShell.PrtgServer
-			
-			$PrtgServerObject.Protocol = $Protocol
-			$PrtgServerObject.Port     = $Port
-			$PrtgServerObject.Server   = $Server
-			$PrtgServerObject.UserName = $UserName
-			$PrtgServerObject.PassHash = $PassHash
-			
-			$PrtgServerObject.OverrideValidation()
+			#$PrtgServerObject.OverrideValidation()
 		}
+		
+		$PrtgServerObject.Protocol = $Protocol
+		$PrtgServerObject.Port     = $Port
     }
 
     PROCESS {
 		$url = $PrtgServerObject.UrlBuilder("api/getstatus.xml")
 
 		try {
-			$QueryObject = HelperHTTPQuery $url -AsXML
+			#$QueryObject = HelperHTTPQuery $url -AsXML
+			#$PrtgServerObject.OverrideValidation()
+			$QueryObject = $PrtgServerObject.HttpQuery($url)
 		} catch {
 			throw "Error performing HTTP query"
 		}
 
 		$Data = $QueryObject.Data
 
-		$data.status.ChildNodes | % {
-			if ($_.Name -ne "IsAdminUser") {
-				$PrtgServerObject.$($_.Name) = $_.InnerText
-			} else {
-				# TODO
-				# there's at least four properties that need to be treated this way
-				# this is because this property returns a text "true" or "false", which powershell always evaluates as "true"
-				$PrtgServerObject.$($_.Name) = [System.Convert]::ToBoolean($_.InnerText)
+		# the logic and future-proofing of this is a bit on the suspect side.
+		# the idea is that we want to get all the properties that it returns
+		# and shove them into our new object, but if the object is missing 
+		# the property in the first place we will get an error. this happens
+		# periodically when paessler adds new properties to the output.
+		#
+		# so how do we gracefully handle new properties?
+		foreach ($ChildNode in $data.status.ChildNodes) {
+			# for now, we outright ignore them.
+			if (($PrtgServerObject | Get-Member | Select-Object -ExpandProperty Name) -contains $ChildNode.Name) {
+				
+				if ($ChildNode.Name -ne "IsAdminUser") {
+					$PrtgServerObject.$($ChildNode.Name) = $ChildNode.InnerText
+				} else {
+					# TODO
+					# there's at least four properties that need to be treated this way
+					# this is because this property returns a text "true" or "false", which powershell always evaluates as "true"
+					$PrtgServerObject.$($ChildNode.Name) = [System.Convert]::ToBoolean($ChildNode.InnerText)
+				}
+				
 			}
 		}
 
         $global:PrtgServerObject = $PrtgServerObject
 
 		#HelperFormatTest ###### need to add this back in
+		# this tests for a decimal-placement bug that existed in the output from some old versions of prtg
 
 		if (!$Quiet) {
 			return $PrtgServerObject | Select-Object @{n='Connection';e={$_.ApiUrl}},UserName,Version

prtgshell2.psm1

@@ -166,17 +166,16 @@ private static bool OnValidateCertificate(object sender, X509Certificate certifi
         public void OverrideValidation() {
             ServicePointManager.ServerCertificateValidationCallback = OnValidateCertificate;
             ServicePointManager.Expect100Continue = true;
-            ServicePointManager.SecurityProtocol = SecurityProtocolType.Ssl3;
+            ServicePointManager.SecurityProtocol = SecurityProtocolType.Tls12;
         }
-
-
+		
         private System.Uri prtguri;
 
         // this likely doesn't need to be public
         // or exist, this is just for peeking
-        public System.Uri PrtgUri {
-            get { return this.prtguri; }
-        }
+        //public System.Uri PrtgUri {
+        //    get { return this.prtguri; }
+        //}
 
         private Hashtable parsed_querystring;
 
@@ -212,6 +211,8 @@ public HttpQueryReturnObject HttpQuery(string Url, bool AsXml = true) {
             // also, all requests should not be treated as XML for this to be more generic
             // (the powershell version had an "-asxml" flag to handle this)
 
+			this.OverrideValidation();
+			
             HttpWebResponse Response = null;
             HttpStatusCode StatusCode = new HttpStatusCode();