Get-SensorType

NAME Get-SensorType



SYNOPSIS

Retrieves all sensor types supported by a PRTG Server.





SYNTAX

Get-SensorType [[-Name] <string>] [-Object <DeviceOrGroupOrProbe>] [<CommonParameters>]



Get-SensorType [[-Name] <string>] -Id <int> [<CommonParameters>]





DESCRIPTION

The Get-SensorType cmdlet retrieves all sensor types from PRTG that are supported by a specified object, allowing

you to identify the Type Id to be used with other cmdlets (such as Get-SensorTarget and New-SensorParameters). If

no -Object or -Id is specified, by default Get-SensorType will retrieve sensor types supported by the Core Probe

(Object ID: 1). Practically speaking, all objects appear to support all sensor types; as such, there should

generally be no need to specify an object.



Results returned by Get-SensorType can be filtered by specifying an expression to the -Name parameter. Sensor type

results will be filtered to those that contain the specified expression anywhere in either the Id, Name or

Description.





PARAMETERS

-Object <DeviceOrGroupOrProbe>

The object to retrieve sensor types from. If no object is specified, PrtgAPI will retrieve all types supported

by the Core Probe (ID 1)



Required? false

Position? named

Default value

Accept pipeline input? true (ByValue)

Accept wildcard characters? false



-Id <int>

The ID of the object to retrieve sensor types from.



Required? true

Position? named

Default value 0

Accept pipeline input? false

Accept wildcard characters? false



-Name <string>

Filters results to those that contain the specified expression in any field.



Required? false

Position? 0

Default value

Accept pipeline input? false

Accept wildcard characters? false



<CommonParameters>

This cmdlet supports the common parameters: Verbose, Debug,

ErrorAction, ErrorVariable, WarningAction, WarningVariable,

OutBuffer, PipelineVariable, and OutVariable. For more information, see

about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).



INPUTS

PrtgAPI.DeviceOrGroupOrProbe

The object to retrieve sensor types from. If no object is specified, PrtgAPI will retrieve all types supported

by the Core Probe (ID 1)





OUTPUTS

PrtgAPI.SensorTypeDescriptor





---------- EXAMPLE 1 ----------



C:\\> Get-SensorType



List all sensor types supported by PRTG.



---------- EXAMPLE 2 ----------



C:\\> Get-SensorType *exchange*



List all sensor types that contain "exchange" in the Id, Name or Description.



---------- EXAMPLE 3 ----------



C:\\> Get-Device -Id 1001 | Get-SensorType



List all sensor types supported by the Device with Id 1001



RELATED LINKS

Online version: https://github.com/lordmilko/PrtgAPI/wi ... or-types-1

Get-SensorTarget

New-SensorParameters

Get-Device