< Back

Get-SensorFactorySource

Sun Jan 19, 2020 5:42 pm

NAME Get-SensorFactorySource



SYNOPSIS

Retrieves source sensors and channels from a PRTG Sensor Factory.





SYNTAX

Get-SensorFactorySource -Sensor <Sensor> [-Channels <SwitchParameter>] [<CommonParameters>]





DESCRIPTION

The Get-SensorFactorySource cmdlet retrieves the source sensors and channels of PRTG Sensor Factory objects. By

default Get-SensorFactorySource retrieves the sensors of the channel definition. If the -Channels parameter is

specified, the cmdlet will retrieve the source channels instead. If a sensor is passed to Get-SensorFactorySource

that isn't a Sensor Factory, an ParameterBindingException will be thrown.





PARAMETERS

-Sensor <Sensor>

The sensor factory sensor to retrieve source sensors or channels of.



Required? true

Position? named

Default value

Accept pipeline input? true (ByValue)

Accept wildcard characters? false



-Channels <SwitchParameter>

Whether to retrieve the source Channel objects of a sensor factory, instead of the source sensors.



Required? false

Position? named

Default value False

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.Sensor

The sensor factory sensor to retrieve source sensors or channels of.





OUTPUTS



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



C:\\> flt type eq "sensor factory" | Get-Sensor -Count 1 | Get-SensorFactorySource



Retrieve all source sensors of a single sensor factory sensor



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



C:\\> flt type eq "sensor factory" | Get-Sensor -Count 1 | Get-SensorFactorySource -Channels



Retrieve all source channels of a single sensor factory sensor



RELATED LINKS

Online version: https://github.com/lordmilko/PrtgAPI/wi ... ry-sources

Get-Sensor

New-SearchFilter