PrtgAPI.dll-Help.xml
|
<?xml version="1.0" encoding="utf-8"?>
<helpItems schema="maml" xmlns="http://msh"> <!-- Cmdlet: Start-AutoDiscovery --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Start-AutoDiscovery</command:name> <command:verb>Start</command:verb> <command:noun>AutoDiscovery</command:noun> <maml:description> <maml:para>Auto-discovers sensors on a PRTG Device.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Start-AutoDiscovery cmdlet initiates an auto-discovery task against a PRTG Device.</maml:para> <maml:para>When auto-discovery runs, PRTG will attempt to automatically create sensors under the device based on a series of built-in templates. If a device is not receptive to a particular sensor type, the sensor is not created.</maml:para> <maml:para>Sensors have a built-in flag to indicate whether they were created by auto-discovery. If auto-discovery identifies a sensor type that is applicable to your device that already has a copy of that sensor that was created manually, auto-discovery will ignore your existing sensor and create a new one alongside it. Because of this, it is always recommended to use auto-discovery based sensors to allow for running auto-discovery multiple times without causing duplicates.</maml:para> <maml:para>If more than 10 auto-discovery tasks are specified, PRTG will queue the additional tasks to limit the load on the system.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Start-AutoDiscovery</maml:name> <!-- Parameter: Device --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Device</maml:name> <maml:description> <maml:para>The device to perform auto-discovery upon.</maml:para> </maml:description> <command:parameterValue required="true">Device</command:parameterValue> <dev:type> <maml:name>PrtgAPI.Device</maml:name> <maml:uri /> <maml:description> <maml:para>A computer or piece of equipment containing one or more sensors monitored by PRTG.</maml:para> </maml:description> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Device --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Device</maml:name> <maml:description> <maml:para>The device to perform auto-discovery upon.</maml:para> </maml:description> <command:parameterValue required="true">Device</command:parameterValue> <dev:type> <maml:name>PrtgAPI.Device</maml:name> <maml:uri /> <maml:description> <maml:para>A computer or piece of equipment containing one or more sensors monitored by PRTG.</maml:para> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>PrtgAPI.Device</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The device to perform auto-discovery upon.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>Get-Device | Start-AutoDiscovery</dev:code> <dev:remarks> <maml:para>Run auto-discovery against all devices.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Get-Device</maml:linkText> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Get-Channel --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-Channel</command:name> <command:verb>Get</command:verb> <command:noun>Channel</command:noun> <maml:description> <maml:para>Retrieves all channels of a sensor.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Get-Channel cmdlet retrieves all channels beloninging to a PRTG Sensor.</maml:para> <maml:para>Get-Channel uses APIs unsupported by Paessler to retrieve advanced channel settings (limits, thresholds, etc). For each channel a separate request must be made in order to retrieve advanced channel details, in addition to a separate single request that retrieves general information for all channels. As such, in order to retrieve information on n channels, n+1 requests must be made. Keep this in mind when piping sensors with a large number of channels, or piping a large number of sensors.</maml:para> <maml:para>If a name is specified, Get-Channel filters the results to those that match the name expression. Due to limitations of the PRTG API, Get-Channel filters its results post-request.</maml:para> <maml:para>Get-Channel does not include the Downtime channel present on all sensors (Channel ID -4) as this sensor does not contain a value in table view. In addition, due to limitations of the PRTG API any channels configured with the setting "Hide from Tables" will not be returned by Get-Channel</maml:para> </maml:description> <command:syntax> <!-- Parameter set: Sensor --> <command:syntaxItem> <maml:name>Get-Channel</maml:name> <!-- Parameter: Name --> <command:parameter required="false" globbing="false" pipelineInput="false" position="0"> <maml:name>Name</maml:name> <maml:description> <maml:para>Filter the channels retrieved to only those that match a specific name.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Sensor --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Sensor</maml:name> <maml:description> <maml:para>The Sensor to retrieve channels for.</maml:para> </maml:description> <command:parameterValue required="true">Sensor</command:parameterValue> <dev:type> <maml:name>PrtgAPI.Sensor</maml:name> <maml:uri /> <maml:description> <maml:para>An object that monitors and collects information according to a defined schedule.</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: Id --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Id</maml:name> <maml:description> <maml:para>Filter the channels retrieved to only those that match a specific ID.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: SensorId --> <command:syntaxItem> <maml:name>Get-Channel</maml:name> <!-- Parameter: Name --> <command:parameter required="false" globbing="false" pipelineInput="false" position="0"> <maml:name>Name</maml:name> <maml:description> <maml:para>Filter the channels retrieved to only those that match a specific name.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: SensorId --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>SensorId</maml:name> <maml:description> <maml:para>The ID of the Sensor to retrieve channels for.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Id --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Id</maml:name> <maml:description> <maml:para>Filter the channels retrieved to only those that match a specific ID.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Sensor --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Sensor</maml:name> <maml:description> <maml:para>The Sensor to retrieve channels for.</maml:para> </maml:description> <command:parameterValue required="true">Sensor</command:parameterValue> <dev:type> <maml:name>PrtgAPI.Sensor</maml:name> <maml:uri /> <maml:description> <maml:para>An object that monitors and collects information according to a defined schedule.</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: SensorId --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>SensorId</maml:name> <maml:description> <maml:para>The ID of the Sensor to retrieve channels for.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Name --> <command:parameter required="false" globbing="false" pipelineInput="false" position="0"> <maml:name>Name</maml:name> <maml:description> <maml:para>Filter the channels retrieved to only those that match a specific name.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Id --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Id</maml:name> <maml:description> <maml:para>Filter the channels retrieved to only those that match a specific ID.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>PrtgAPI.Sensor</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The Sensor to retrieve channels for.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The ID of the Sensor to retrieve channels for.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: Channel --> <command:returnValue> <dev:type> <maml:name>PrtgAPI.Channel</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>A value within a sensor that contains the results of monitoring operations.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>C:\> Get-Sensor -Tags wmicpuloadsensor | Get-Channel</dev:code> <dev:remarks> <maml:para>Get all channels from all Windows CPU Load sensors.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>C:\> Get-Sensor -Tags wmimemorysensor | Get-Channel Avail*</dev:code> <dev:remarks> <maml:para>Get all channels whose names start with "Avail" from all Windows Memory sensors.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 3 ----------</maml:title> <dev:code>C:\> Get-Channel -SensorId 2001</dev:code> <dev:remarks> <maml:para>Get all channels from the sensor with ID 2001</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Get-Sensor</maml:linkText> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-ChannelProperty</maml:linkText> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Set-ChannelProperty --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Set-ChannelProperty</command:name> <command:verb>Set</command:verb> <command:noun>ChannelProperty</command:noun> <maml:description> <maml:para>Modifies the value of a channel property.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Set-ChannelProperty cmdlet modifies properties and settings of PRTG Channels. All supported properties that can be modified are typesafe, using the type of the property on the Channel object returned from Get-Channel.</maml:para> <maml:para>When a value is specified, Set-ChannelProperty will attempt to parse the value into its expected type. If the type cannot be parsed, an exception will be thrown indicating the type of the object specified and the type that was expected. In the case of enums, Set-ChannelProperty will list all valid values of the target type so that you may know exactly how to interface with the specified property.</maml:para> <maml:para>In the event that a property is specified that has a dependency on another property ebing set (such as UpperErrorLimit requiring LimitsEnabled be $true) Set-ChannelProperty will automatically assign the required values such that the original property may be correctly enabled. If the parent of a property is set to the opposite of a child property's required value PrtgAPI will automatically remove the value specified on the child as well. For example, if LimitsEnabled is set to $false, all error and warning limit related properties will be set to $null. If LimitsEnabled is later set to $true, you will need to repopulate the values of all error and warning limit properties.</maml:para> <maml:para>For a list of all settings currently supported by Set-ChannelProperty, see Get-Help about_ChannelSettings.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: Default --> <command:syntaxItem> <maml:name>Set-ChannelProperty</maml:name> <!-- Parameter: Property --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>Property</maml:name> <maml:description> <maml:para>Property of the channel to set.</maml:para> <maml:para>Possible values: Unit, ValueLookup, ScalingMultiplication, ScalingDivision, ShowInGraph, ColorMode, LineColor, LineWidth, HistoricValueMode, DecimalMode, DecimalPlaces, SpikeFilterEnabled, SpikeFilterMax, SpikeFilterMin, PercentMode, PercentValue, LimitsEnabled, UpperErrorLimit, UpperWarningLimit, LowerErrorLimit, LowerWarningLimit, ErrorLimitMessage, WarningLimitMessage</maml:para> </maml:description> <command:parameterValue required="true">ChannelProperty</command:parameterValue> <dev:type> <maml:name>PrtgAPI.ChannelProperty</maml:name> <maml:uri /> <maml:description> <maml:para>Specifies the properties of sensor channels that can be interfaced with using the PRTG API.</maml:para> </maml:description> </dev:type> <dev:defaultValue>Unit</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Unit</command:parameterValue> <command:parameterValue required="false" variableLength="false">ValueLookup</command:parameterValue> <command:parameterValue required="false" variableLength="false">ScalingMultiplication</command:parameterValue> <command:parameterValue required="false" variableLength="false">ScalingDivision</command:parameterValue> <command:parameterValue required="false" variableLength="false">ShowInGraph</command:parameterValue> <command:parameterValue required="false" variableLength="false">ColorMode</command:parameterValue> <command:parameterValue required="false" variableLength="false">LineColor</command:parameterValue> <command:parameterValue required="false" variableLength="false">LineWidth</command:parameterValue> <command:parameterValue required="false" variableLength="false">HistoricValueMode</command:parameterValue> <command:parameterValue required="false" variableLength="false">DecimalMode</command:parameterValue> <command:parameterValue required="false" variableLength="false">DecimalPlaces</command:parameterValue> <command:parameterValue required="false" variableLength="false">SpikeFilterEnabled</command:parameterValue> <command:parameterValue required="false" variableLength="false">SpikeFilterMax</command:parameterValue> <command:parameterValue required="false" variableLength="false">SpikeFilterMin</command:parameterValue> <command:parameterValue required="false" variableLength="false">PercentMode</command:parameterValue> <command:parameterValue required="false" variableLength="false">PercentValue</command:parameterValue> <command:parameterValue required="false" variableLength="false">LimitsEnabled</command:parameterValue> <command:parameterValue required="false" variableLength="false">UpperErrorLimit</command:parameterValue> <command:parameterValue required="false" variableLength="false">UpperWarningLimit</command:parameterValue> <command:parameterValue required="false" variableLength="false">LowerErrorLimit</command:parameterValue> <command:parameterValue required="false" variableLength="false">LowerWarningLimit</command:parameterValue> <command:parameterValue required="false" variableLength="false">ErrorLimitMessage</command:parameterValue> <command:parameterValue required="false" variableLength="false">WarningLimitMessage</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: Value --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Value</maml:name> <maml:description> <maml:para>Value to set the property to.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Channel --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Channel</maml:name> <maml:description> <maml:para>Channel to set the properties of.</maml:para> </maml:description> <command:parameterValue required="true">Channel</command:parameterValue> <dev:type> <maml:name>PrtgAPI.Channel</maml:name> <maml:uri /> <maml:description> <maml:para>A value within a sensor that contains the results of monitoring operations.</maml:para> </maml:description> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: Manual --> <command:syntaxItem> <maml:name>Set-ChannelProperty</maml:name> <!-- Parameter: Property --> <command:parameter required="true" globbing="false" pipelineInput="false" position="2"> <maml:name>Property</maml:name> <maml:description> <maml:para>Property of the channel to set.</maml:para> <maml:para>Possible values: Unit, ValueLookup, ScalingMultiplication, ScalingDivision, ShowInGraph, ColorMode, LineColor, LineWidth, HistoricValueMode, DecimalMode, DecimalPlaces, SpikeFilterEnabled, SpikeFilterMax, SpikeFilterMin, PercentMode, PercentValue, LimitsEnabled, UpperErrorLimit, UpperWarningLimit, LowerErrorLimit, LowerWarningLimit, ErrorLimitMessage, WarningLimitMessage</maml:para> </maml:description> <command:parameterValue required="true">ChannelProperty</command:parameterValue> <dev:type> <maml:name>PrtgAPI.ChannelProperty</maml:name> <maml:uri /> <maml:description> <maml:para>Specifies the properties of sensor channels that can be interfaced with using the PRTG API.</maml:para> </maml:description> </dev:type> <dev:defaultValue>Unit</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Unit</command:parameterValue> <command:parameterValue required="false" variableLength="false">ValueLookup</command:parameterValue> <command:parameterValue required="false" variableLength="false">ScalingMultiplication</command:parameterValue> <command:parameterValue required="false" variableLength="false">ScalingDivision</command:parameterValue> <command:parameterValue required="false" variableLength="false">ShowInGraph</command:parameterValue> <command:parameterValue required="false" variableLength="false">ColorMode</command:parameterValue> <command:parameterValue required="false" variableLength="false">LineColor</command:parameterValue> <command:parameterValue required="false" variableLength="false">LineWidth</command:parameterValue> <command:parameterValue required="false" variableLength="false">HistoricValueMode</command:parameterValue> <command:parameterValue required="false" variableLength="false">DecimalMode</command:parameterValue> <command:parameterValue required="false" variableLength="false">DecimalPlaces</command:parameterValue> <command:parameterValue required="false" variableLength="false">SpikeFilterEnabled</command:parameterValue> <command:parameterValue required="false" variableLength="false">SpikeFilterMax</command:parameterValue> <command:parameterValue required="false" variableLength="false">SpikeFilterMin</command:parameterValue> <command:parameterValue required="false" variableLength="false">PercentMode</command:parameterValue> <command:parameterValue required="false" variableLength="false">PercentValue</command:parameterValue> <command:parameterValue required="false" variableLength="false">LimitsEnabled</command:parameterValue> <command:parameterValue required="false" variableLength="false">UpperErrorLimit</command:parameterValue> <command:parameterValue required="false" variableLength="false">UpperWarningLimit</command:parameterValue> <command:parameterValue required="false" variableLength="false">LowerErrorLimit</command:parameterValue> <command:parameterValue required="false" variableLength="false">LowerWarningLimit</command:parameterValue> <command:parameterValue required="false" variableLength="false">ErrorLimitMessage</command:parameterValue> <command:parameterValue required="false" variableLength="false">WarningLimitMessage</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: Value --> <command:parameter required="false" globbing="false" pipelineInput="false" position="3"> <maml:name>Value</maml:name> <maml:description> <maml:para>Value to set the property to.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ChannelId --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ChannelId</maml:name> <maml:description> <maml:para>ID of the channel to set the properties of.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: SensorId --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>SensorId</maml:name> <maml:description> <maml:para>ID of the channel's parent sensor.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Channel --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Channel</maml:name> <maml:description> <maml:para>Channel to set the properties of.</maml:para> </maml:description> <command:parameterValue required="true">Channel</command:parameterValue> <dev:type> <maml:name>PrtgAPI.Channel</maml:name> <maml:uri /> <maml:description> <maml:para>A value within a sensor that contains the results of monitoring operations.</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: SensorId --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>SensorId</maml:name> <maml:description> <maml:para>ID of the channel's parent sensor.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ChannelId --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ChannelId</maml:name> <maml:description> <maml:para>ID of the channel to set the properties of.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Property --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>Property</maml:name> <maml:description> <maml:para>Property of the channel to set.</maml:para> <maml:para>Possible values: Unit, ValueLookup, ScalingMultiplication, ScalingDivision, ShowInGraph, ColorMode, LineColor, LineWidth, HistoricValueMode, DecimalMode, DecimalPlaces, SpikeFilterEnabled, SpikeFilterMax, SpikeFilterMin, PercentMode, PercentValue, LimitsEnabled, UpperErrorLimit, UpperWarningLimit, LowerErrorLimit, LowerWarningLimit, ErrorLimitMessage, WarningLimitMessage</maml:para> </maml:description> <command:parameterValue required="true">ChannelProperty</command:parameterValue> <dev:type> <maml:name>PrtgAPI.ChannelProperty</maml:name> <maml:uri /> <maml:description> <maml:para>Specifies the properties of sensor channels that can be interfaced with using the PRTG API.</maml:para> </maml:description> </dev:type> <dev:defaultValue>Unit</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Unit</command:parameterValue> <command:parameterValue required="false" variableLength="false">ValueLookup</command:parameterValue> <command:parameterValue required="false" variableLength="false">ScalingMultiplication</command:parameterValue> <command:parameterValue required="false" variableLength="false">ScalingDivision</command:parameterValue> <command:parameterValue required="false" variableLength="false">ShowInGraph</command:parameterValue> <command:parameterValue required="false" variableLength="false">ColorMode</command:parameterValue> <command:parameterValue required="false" variableLength="false">LineColor</command:parameterValue> <command:parameterValue required="false" variableLength="false">LineWidth</command:parameterValue> <command:parameterValue required="false" variableLength="false">HistoricValueMode</command:parameterValue> <command:parameterValue required="false" variableLength="false">DecimalMode</command:parameterValue> <command:parameterValue required="false" variableLength="false">DecimalPlaces</command:parameterValue> <command:parameterValue required="false" variableLength="false">SpikeFilterEnabled</command:parameterValue> <command:parameterValue required="false" variableLength="false">SpikeFilterMax</command:parameterValue> <command:parameterValue required="false" variableLength="false">SpikeFilterMin</command:parameterValue> <command:parameterValue required="false" variableLength="false">PercentMode</command:parameterValue> <command:parameterValue required="false" variableLength="false">PercentValue</command:parameterValue> <command:parameterValue required="false" variableLength="false">LimitsEnabled</command:parameterValue> <command:parameterValue required="false" variableLength="false">UpperErrorLimit</command:parameterValue> <command:parameterValue required="false" variableLength="false">UpperWarningLimit</command:parameterValue> <command:parameterValue required="false" variableLength="false">LowerErrorLimit</command:parameterValue> <command:parameterValue required="false" variableLength="false">LowerWarningLimit</command:parameterValue> <command:parameterValue required="false" variableLength="false">ErrorLimitMessage</command:parameterValue> <command:parameterValue required="false" variableLength="false">WarningLimitMessage</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: Value --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Value</maml:name> <maml:description> <maml:para>Value to set the property to.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>PrtgAPI.Channel</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Channel to set the properties of.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>C:\> Get-Sensor -Tags wmicpuloadsensor | Get-Channel Total | Set-ChannelProperty UpperErrorLimit 90</dev:code> <dev:remarks> <maml:para>Set the upper error limit of the "Total" channel of all WMI CPU Load sensors to 90. Will also set LimitsEnabled to $true</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>about_ChannelSettings</maml:linkText> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-Channel</maml:linkText> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-Sensor</maml:linkText> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Copy-Device --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Copy-Device</command:name> <command:verb>Copy</command:verb> <command:noun>Device</command:noun> <maml:description> <maml:para>Clones a device within PRTG.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Clone-Device cmdlet duplicates a PRTG Device, including all sensors and settings defined under it.</maml:para> <maml:para>To clone a device you must specify the Object ID of the group or probe the cloned device will sit under. If a Name is not specified, Clone-Device will automatically name the device as "Clone of <device>, where <device> is the name of the original device.</maml:para> <maml:para>If you wish to specify a custom hostname/IP Address for the device, you can specify the HostName parameter. If a HostName is not specified, the hostname/IP Address of the original device will be used.</maml:para> <maml:para>When a device has been cloned, by default Clone-Device will attempt to resolve the object into a PrtgAPI Device. Based on the speed of your PRTG Server, this can sometimes result in a delay of 5-10 seconds due to the delay with which PRTG clones the object. If Clone-Device cannot resolve the resultant object on the first attempt, PrtgAPI will make a further 10 retries, pausing for a successively greater duration between each try. After each failed attempt a warning will be displayed indicating the number of attempts remaining. Object resolution can be aborted at any time by pressing an escape sequence such as Ctrl+C.</maml:para> <maml:para>If you do not wish to resolve the resultant object, you can specify -Resolve:$false, which will cause Clone-Device to output a clone summary, including the object ID, name and hostname of the new object. As PRTG pauses all cloned objects by default, it is generally recommended to resolve the new object so that you may unpause the object with Resume-Object.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Copy-Device</maml:name> <!-- Parameter: DestinationId --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>DestinationId</maml:name> <maml:description> <maml:para>The ID of the device (for sensors), group or probe (for groups and devices) that will hold the cloned object.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: Name --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name to rename the cloned object to.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: HostName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>HostName</maml:name> <maml:description> <maml:para>The hostname or IP Address to set on the cloned device.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Device --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Device</maml:name> <maml:description> <maml:para>The device to clone.</maml:para> </maml:description> <command:parameterValue required="true">Device</command:parameterValue> <dev:type> <maml:name>PrtgAPI.Device</maml:name> <maml:uri /> <maml:description> <maml:para>A computer or piece of equipment containing one or more sensors monitored by PRTG.</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: Resolve --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Resolve</maml:name> <maml:description> <maml:para>Indicates whether or not the cloned object should be resolved into a PrtgObject. By default this value is true (perform resolution). If this value is false, a summary of the clone operation will be provided.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>True</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Device --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Device</maml:name> <maml:description> <maml:para>The device to clone.</maml:para> </maml:description> <command:parameterValue required="true">Device</command:parameterValue> <dev:type> <maml:name>PrtgAPI.Device</maml:name> <maml:uri /> <maml:description> <maml:para>A computer or piece of equipment containing one or more sensors monitored by PRTG.</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: HostName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>HostName</maml:name> <maml:description> <maml:para>The hostname or IP Address to set on the cloned device.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: DestinationId --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>DestinationId</maml:name> <maml:description> <maml:para>The ID of the device (for sensors), group or probe (for groups and devices) that will hold the cloned object.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: Name --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name to rename the cloned object to.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Resolve --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Resolve</maml:name> <maml:description> <maml:para>Indicates whether or not the cloned object should be resolved into a PrtgObject. By default this value is true (perform resolution). If this value is false, a summary of the clone operation will be provided.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>True</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>PrtgAPI.Device</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The device to clone.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: Device --> <command:returnValue> <dev:type> <maml:name>PrtgAPI.Device</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>A computer or piece of equipment containing one or more sensors monitored by PRTG.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>C:\> Get-Device -Id 1234 | Clone-Device 5678</dev:code> <dev:remarks> <maml:para>Clone the device with ID 1234 to the group or probe with ID 5678</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>C:\> Get-Device -Id 1234 | Clone-Device 5678 MyNewDevice 192.168.1.1</dev:code> <dev:remarks> <maml:para>Clone the device with ID 1234 into the group or probe with ID 5678 renamed as "MyNewDevice" with IP Address 192.168.1.1</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 3 ----------</maml:title> <dev:code>C:\> Get-Device -Id 1234 | Clone-Device 5678 -Resolve:$false</dev:code> <dev:remarks> <maml:para>Clone the device with ID 1234 to the group or probe with ID 5678 without resolving the resultant PrtgObject.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Get-Device</maml:linkText> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Clone-Group</maml:linkText> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Clone-Sensor</maml:linkText> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Resume-Object</maml:linkText> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Get-Device --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-Device</command:name> <command:verb>Get</command:verb> <command:noun>Device</command:noun> <maml:description> <maml:para>Retrieves devices from a PRTG Server.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Get-Device cmdlet retrieves devices from a PRTG Server. Devices hold sensors used to monitor a particular system. Get-Device provides a variety of methods of filtering the devices requested from PRTG, including by device name, ID and tags, as well as parent probe/group. Multiple filters can be used in conjunction to futher limit the number of results returned.</maml:para> <maml:para>For scenarios in which you wish to filter on properties not covered by parameters available in Get-Device, a custom SearchFilter object can be created by specifying the field name, condition and value to filter upon. For information on properties that can be filtered upon, see New-SearchFilter.</maml:para> <maml:para>The Device objects returned from Get-Device can be piped to a variety of other cmdlets for further processing, including Get-Sensor, wherein the ID of each device will be used to filter for its parent sensors.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Get-Device</maml:name> <!-- Parameter: Name --> <command:parameter required="false" globbing="false" pipelineInput="false" position="0"> <maml:name>Name</maml:name> <maml:description> <maml:para>Filter the response to objects with a certain name. Can include wildcards.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Filter --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="1"> <maml:name>Filter</maml:name> <maml:description> <maml:para>Filter the response to objects that match one or more criteria.</maml:para> </maml:description> <command:parameterValue required="true">SearchFilter[]</command:parameterValue> <dev:type> <maml:name>PrtgAPI.SearchFilter[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Count --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Count</maml:name> <maml:description> <maml:para>Maximum number of results to return.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Group --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Group</maml:name> <maml:description> <maml:para>The group to retrieve devices for.</maml:para> </maml:description> <command:parameterValue required="true">Group</command:parameterValue> <dev:type> <maml:name>PrtgAPI.Group</maml:name> <maml:uri /> <maml:description> <maml:para>A group used to organize one or more devices.</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: Id --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Id</maml:name> <maml:description> <maml:para>Retrieve an object with a specified ID.</maml:para> </maml:description> <command:parameterValue required="true">Nullable`1[]</command:parameterValue> <dev:type> <maml:name>System.Nullable`1[[System.Int32, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]][]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Probe --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Probe</maml:name> <maml:description> <maml:para>The probe to retrieve devices for.</maml:para> </maml:description> <command:parameterValue required="true">Probe</command:parameterValue> <dev:type> <maml:name>PrtgAPI.Probe</maml:name> <maml:uri /> <maml:description> <maml:para>A device used to perform monitoring against a site or set of systems.</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: Status --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Status</maml:name> <maml:description> <maml:para>Only retrieve objects that match a specific status.</maml:para> </maml:description> <command:parameterValue required="true">Status[]</command:parameterValue> <dev:type> <maml:name>PrtgAPI.Status[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Tags --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Tags</maml:name> <maml:description> <maml:para>Filter the response to objects with certain tags. Can include wildcards.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Group --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Group</maml:name> <maml:description> <maml:para>The group to retrieve devices for.</maml:para> </maml:description> <command:parameterValue required="true">Group</command:parameterValue> <dev:type> <maml:name>PrtgAPI.Group</maml:name> <maml:uri /> <maml:description> <maml:para>A group used to organize one or more devices.</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: Probe --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Probe</maml:name> <maml:description> <maml:para>The probe to retrieve devices for.</maml:para> </maml:description> <command:parameterValue required="true">Probe</command:parameterValue> <dev:type> <maml:name>PrtgAPI.Probe</maml:name> <maml:uri /> <maml:description> <maml:para>A device used to perform monitoring against a site or set of systems.</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: Name --> <command:parameter required="false" globbing="false" pipelineInput="false" position="0"> <maml:name>Name</maml:name> <maml:description> <maml:para>Filter the response to objects with a certain name. Can include wildcards.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Id --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Id</maml:name> <maml:description> <maml:para>Retrieve an object with a specified ID.</maml:para> </maml:description> <command:parameterValue required="true">Nullable`1[]</command:parameterValue> <dev:type> <maml:name>System.Nullable`1[[System.Int32, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]][]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Filter --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="1"> <maml:name>Filter</maml:name> <maml:description> <maml:para>Filter the response to objects that match one or more criteria.</maml:para> </maml:description> <command:parameterValue required="true">SearchFilter[]</command:parameterValue> <dev:type> <maml:name>PrtgAPI.SearchFilter[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Tags --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Tags</maml:name> <maml:description> <maml:para>Filter the response to objects with certain tags. Can include wildcards.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Status --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Status</maml:name> <maml:description> <maml:para>Only retrieve objects that match a specific status.</maml:para> </maml:description> <command:parameterValue required="true">Status[]</command:parameterValue> <dev:type> <maml:name>PrtgAPI.Status[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Count --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Count</maml:name> <maml:description> <maml:para>Maximum number of results to return.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>PrtgAPI.Group</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The group to retrieve devices for.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>PrtgAPI.Probe</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The probe to retrieve devices for.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>PrtgAPI.SearchFilter[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Filter the response to objects that match one or more criteria.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>PrtgAPI.Status[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Only retrieve objects that match a specific status.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: Device --> <command:returnValue> <dev:type> <maml:name>PrtgAPI.Device</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>A computer or piece of equipment containing one or more sensors monitored by PRTG.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>C:\> Get-Device dc-1</dev:code> <dev:remarks> <maml:para>Get all devices named "dc-1" (case insensitive)</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>C:\> Get-Device *exch*</dev:code> <dev:remarks> <maml:para>Get all devices whose name contains "exch" (case insensitive)</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 3 ----------</maml:title> <dev:code>C:\> Get-Device -Id 2000</dev:code> <dev:remarks> <maml:para>Get the device with ID 2000</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 4 ----------</maml:title> <dev:code>C:\> Get-Probe contoso | Get-Device</dev:code> <dev:remarks> <maml:para>Get all devices from the probe named "contoso"</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 5 ----------</maml:title> <dev:code>C:\> Get-Device -Tags C_OS_Win</dev:code> <dev:remarks> <maml:para>Get all devices that have the tag "C_OS_Win"</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 6 ----------</maml:title> <dev:code>C:\> Get-Device -Count 1</dev:code> <dev:remarks> <maml:para>Get only 1 device from PRTG.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 7 ----------</maml:title> <dev:code>New-SearchFilter location contains "new york" | Get-Device</dev:code> <dev:remarks> <maml:para>Get all devices whose location contains "new york"</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Get-Sensor</maml:linkText> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-Group</maml:linkText> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-Probe</maml:linkText> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Test-ErrorStatus --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Test-ErrorStatus</command:name> <command:verb>Test</command:verb> <command:noun>ErrorStatus</command:noun> <maml:description> <maml:para>Simulates an error status on a PRTG Sensor.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Simulate-ErrorStatus cmdlet forces a PRTG Sensor to enter an error (Down) state. When an object is in a simulated error status, it will display a message indicating it is in a simulated error state. Any object put into a simulated error status will remain in this state until the object is resumed via the Resume-Object cmdlet or via the PRTG UI. Even if an object is paused, it will return to an error state when the object is unpaused.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Test-ErrorStatus</maml:name> <!-- Parameter: Sensor --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Sensor</maml:name> <maml:description> <maml:para>The sensor to simulate an error status on.</maml:para> </maml:description> <command:parameterValue required="true">Sensor</command:parameterValue> <dev:type> <maml:name>PrtgAPI.Sensor</maml:name> <maml:uri /> <maml:description> <maml:para>An object that monitors and collects information according to a defined schedule.</maml:para> </maml:description> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Sensor --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Sensor</maml:name> <maml:description> <maml:para>The sensor to simulate an error status on.</maml:para> </maml:description> <command:parameterValue required="true">Sensor</command:parameterValue> <dev:type> <maml:name>PrtgAPI.Sensor</maml:name> <maml:uri /> <maml:description> <maml:para>An object that monitors and collects information according to a defined schedule.</maml:para> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>PrtgAPI.Sensor</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The sensor to simulate an error status on.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>C:\> Get-Sensor -Id 1001 | Simulate-ErrorStatus</dev:code> <dev:remarks> <maml:para>Force the sensor with ID to enter an error state.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Resume-Object</maml:linkText> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Copy-Group --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Copy-Group</command:name> <command:verb>Copy</command:verb> <command:noun>Group</command:noun> <maml:description> <maml:para>Clones a group within PRTG.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Clone-Group cmdlet duplicates a PRTG Group, including all devices and sensors defined under it.</maml:para> <maml:para>To clone a group, you must specify the Object ID of the group or probe the cloned group will sit under. If a Name is not specified, the name of the group being cloned will be used.</maml:para> <maml:para>When a group has been cloned, by default Clone-Group will attempt to resolve the object into a PrtgAPI Group. Based on the speed of your PRTG Server, this can sometimes result in a delay of 5-10 seconds due to the delay with which PRTG clones the object. If Clone-Group cannot resolve the resultant object on the first attempt, PrtgAPI will make a further 10 retries, pausing for a successively greater duration between each try. After each failed attempt a warning will be displayed indicating the number of attempts remaining. Object resolution can be aborted at any time by pressing an escape sequence such as Ctrl+C.</maml:para> <maml:para>If you do not wish to resolve the resultant object, you can specify -Resolve:$false, which will cause Clone-Group to output a clone summary, including the object ID and name of the new object. As PRTG pauses all cloned objects by default, it is generally recommended to resolve the new object so that you may unpause the object with Resume-Object.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Copy-Group</maml:name> <!-- Parameter: DestinationId --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>DestinationId</maml:name> <maml:description> <maml:para>The ID of the device (for sensors), group or probe (for groups and devices) that will hold the cloned object.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: Name --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name to rename the cloned object to.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Group --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Group</maml:name> <maml:description> <maml:para>The group to clone.</maml:para> </maml:description> <command:parameterValue required="true">Group</command:parameterValue> <dev:type> <maml:name>PrtgAPI.Group</maml:name> <maml:uri /> <maml:description> <maml:para>A group used to organize one or more devices.</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: Resolve --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Resolve</maml:name> <maml:description> <maml:para>Indicates whether or not the cloned object should be resolved into a PrtgObject. By default this value is true (perform resolution). If this value is false, a summary of the clone operation will be provided.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>True</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Group --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Group</maml:name> <maml:description> <maml:para>The group to clone.</maml:para> </maml:description> <command:parameterValue required="true">Group</command:parameterValue> <dev:type> <maml:name>PrtgAPI.Group</maml:name> <maml:uri /> <maml:description> <maml:para>A group used to organize one or more devices.</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: DestinationId --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>DestinationId</maml:name> <maml:description> <maml:para>The ID of the device (for sensors), group or probe (for groups and devices) that will hold the cloned object.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: Name --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name to rename the cloned object to.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Resolve --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Resolve</maml:name> <maml:description> <maml:para>Indicates whether or not the cloned object should be resolved into a PrtgObject. By default this value is true (perform resolution). If this value is false, a summary of the clone operation will be provided.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>True</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>PrtgAPI.Group</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The group to clone.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: Group --> <command:returnValue> <dev:type> <maml:name>PrtgAPI.Group</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>A group used to organize one or more devices.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>C:\> Get-Group -Id 1234 | Clone-Group 5678</dev:code> <dev:remarks> <maml:para>Clone the group with ID 1234 to the group or probe with ID 5678</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>C:\> Get-Group -Id 1234 | Clone-Group 5678 MyNewGroup</dev:code> <dev:remarks> <maml:para>Clone the group with ID 1234 to the group or probe with ID 5678 renamed as "MyNewGroup"</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 3 ----------</maml:title> <dev:code>C:\> Get-Group -Id 1234 | Clone-Group 5678 -Resolve:$false</dev:code> <dev:remarks> <maml:para>Clone the group with ID 1234 into the group or probe with ID 5678 without resolving the resultant PrtgObject</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Get-Group</maml:linkText> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Clone-Sensor</maml:linkText> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Clone-Device</maml:linkText> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Resume-Object</maml:linkText> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Get-Group --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-Group</command:name> <command:verb>Get</command:verb> <command:noun>Group</command:noun> <maml:description> <maml:para>Retrieves groups from a PRTG Server.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Get-Group cmdlet retrieves groups from a PRTG Server. Groups allow you to organize devices and other groups together. In addition, the root node of PRTG containing all probes in the system is marked as a group. Get-Group provides a variety of methods of filtering the groups requested from PRTG, including by group name, ID and tags, as well as by parent probe/group. Multiple filters can be used in conjunction to further limit the number of results returned.</maml:para> <maml:para>For scenarios in which you wish to filter on properties not covered by parameters available in Get-Device, a custom SearchFilter object can be created by specifying the field name, condition and value to filter upon. For more information on properties that can be filtered upon, see New-SearchFilter.</maml:para> <maml:para>The Group objects returned from Get-Group can be piped to a variety of other cmdlets for further processing, including Get-Group, Get-Device and Get-Sensor, where the ID or name of the group will be used to filter for child objects of the specified type.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Get-Group</maml:name> <!-- Parameter: Name --> <command:parameter required="false" globbing="false" pipelineInput="false" position="0"> <maml:name>Name</maml:name> <maml:description> <maml:para>Filter the response to objects with a certain name. Can include wildcards.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Filter --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="1"> <maml:name>Filter</maml:name> <maml:description> <maml:para>Filter the response to objects that match one or more criteria.</maml:para> </maml:description> <command:parameterValue required="true">SearchFilter[]</command:parameterValue> <dev:type> <maml:name>PrtgAPI.SearchFilter[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Count --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Count</maml:name> <maml:description> <maml:para>Maximum number of results to return.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Group --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Group</maml:name> <maml:description> <maml:para>The parent group to retrieve groups for.</maml:para> </maml:description> <command:parameterValue required="true">Group</command:parameterValue> <dev:type> <maml:name>PrtgAPI.Group</maml:name> <maml:uri /> <maml:description> <maml:para>A group used to organize one or more devices.</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: Id --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Id</maml:name> <maml:description> <maml:para>Retrieve an object with a specified ID.</maml:para> </maml:description> <command:parameterValue required="true">Nullable`1[]</command:parameterValue> <dev:type> <maml:name>System.Nullable`1[[System.Int32, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]][]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Probe --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Probe</maml:name> <maml:description> <maml:para>The probe to retrieve groups for.</maml:para> </maml:description> <command:parameterValue required="true">Probe</command:parameterValue> <dev:type> <maml:name>PrtgAPI.Probe</maml:name> <maml:uri /> <maml:description> <maml:para>A device used to perform monitoring against a site or set of systems.</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: Status --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Status</maml:name> <maml:description> <maml:para>Only retrieve objects that match a specific status.</maml:para> </maml:description> <command:parameterValue required="true">Status[]</command:parameterValue> <dev:type> <maml:name>PrtgAPI.Status[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Tags --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Tags</maml:name> <maml:description> <maml:para>Filter the response to objects with certain tags. Can include wildcards.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Group --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Group</maml:name> <maml:description> <maml:para>The parent group to retrieve groups for.</maml:para> </maml:description> <command:parameterValue required="true">Group</command:parameterValue> <dev:type> <maml:name>PrtgAPI.Group</maml:name> <maml:uri /> <maml:description> <maml:para>A group used to organize one or more devices.</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: Probe --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Probe</maml:name> <maml:description> <maml:para>The probe to retrieve groups for.</maml:para> </maml:description> <command:parameterValue required="true">Probe</command:parameterValue> <dev:type> <maml:name>PrtgAPI.Probe</maml:name> <maml:uri /> <maml:description> <maml:para>A device used to perform monitoring against a site or set of systems.</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: Name --> <command:parameter required="false" globbing="false" pipelineInput="false" position="0"> <maml:name>Name</maml:name> <maml:description> <maml:para>Filter the response to objects with a certain name. Can include wildcards.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Id --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Id</maml:name> <maml:description> <maml:para>Retrieve an object with a specified ID.</maml:para> </maml:description> <command:parameterValue required="true">Nullable`1[]</command:parameterValue> <dev:type> <maml:name>System.Nullable`1[[System.Int32, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]][]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Filter --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="1"> <maml:name>Filter</maml:name> <maml:description> <maml:para>Filter the response to objects that match one or more criteria.</maml:para> </maml:description> <command:parameterValue required="true">SearchFilter[]</command:parameterValue> <dev:type> <maml:name>PrtgAPI.SearchFilter[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Tags --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Tags</maml:name> <maml:description> <maml:para>Filter the response to objects with certain tags. Can include wildcards.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Status --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Status</maml:name> <maml:description> <maml:para>Only retrieve objects that match a specific status.</maml:para> </maml:description> <command:parameterValue required="true">Status[]</command:parameterValue> <dev:type> <maml:name>PrtgAPI.Status[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Count --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Count</maml:name> <maml:description> <maml:para>Maximum number of results to return.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>PrtgAPI.Group</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The parent group to retrieve groups for.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>PrtgAPI.Probe</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The probe to retrieve groups for.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>PrtgAPI.SearchFilter[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Filter the response to objects that match one or more criteria.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>PrtgAPI.Status[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Only retrieve objects that match a specific status.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: Group --> <command:returnValue> <dev:type> <maml:name>PrtgAPI.Group</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>A group used to organize one or more devices.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>C:\> Get-Group Servers</dev:code> <dev:remarks> <maml:para>Get all groups named "Servers" (case insensitive)</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>C:\> Get-Group *windows*</dev:code> <dev:remarks> <maml:para>Get all groups whose name contains "windows" (case insensitive)</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 3 ----------</maml:title> <dev:code>C:\> Get-Group -Id 2005</dev:code> <dev:remarks> <maml:para>Get the group with ID 2005</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 4 ----------</maml:title> <dev:code>C:\> Get-Probe contoso | Get-Group</dev:code> <dev:remarks> <maml:para>Get all groups under the probe named "contoso"</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 5 ----------</maml:title> <dev:code>C:\> Get-Group -Count 1</dev:code> <dev:remarks> <maml:para>Get only 1 group from PRTG.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Get-Sensor</maml:linkText> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-Device</maml:linkText> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-Probe</maml:linkText> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-SearchFilter</maml:linkText> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Get-ModificationHistory --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-ModificationHistory</command:name> <command:verb>Get</command:verb> <command:noun>ModificationHistory</command:noun> <maml:description> <maml:para>Retrieves the setting/state modification history of a PRTG Object.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>THe Get-ModificationHistory cmdlet retrieves all setting/state modifications of an object. The Get-ModificationHistory cmdlet corresponds with the "History" tab of objects in the PRTG UI.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: Default --> <command:syntaxItem> <maml:name>Get-ModificationHistory</maml:name> <!-- Parameter: Object --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Object</maml:name> <maml:description> <maml:para>The object to retrieve historical data for.</maml:para> </maml:description> <command:parameterValue required="true">SensorOrDeviceOrGroupOrProbe</command:parameterValue> <dev:type> <maml:name>PrtgAPI.Objects.Shared.SensorOrDeviceOrGroupOrProbe</maml:name> <maml:uri /> <maml:description> <maml:para>Properties that apply to Sensors, Devices, Groups and Probes.</maml:para> </maml:description> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: Manual --> <command:syntaxItem> <maml:name>Get-ModificationHistory</maml:name> <!-- Parameter: Id --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Id</maml:name> <maml:description> <maml:para>The ID of the object to retrieve historical data for.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Object --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Object</maml:name> <maml:description> <maml:para>The object to retrieve historical data for.</maml:para> </maml:description> <command:parameterValue required="true">SensorOrDeviceOrGroupOrProbe</command:parameterValue> <dev:type> <maml:name>PrtgAPI.Objects.Shared.SensorOrDeviceOrGroupOrProbe</maml:name> <maml:uri /> <maml:description> <maml:para>Properties that apply to Sensors, Devices, Groups and Probes.</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: Id --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Id</maml:name> <maml:description> <maml:para>The ID of the object to retrieve historical data for.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>PrtgAPI.Objects.Shared.SensorOrDeviceOrGroupOrProbe</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The object to retrieve historical data for.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>C:\> Get-Sensor -Id 1001 | Get-ModificationHistory</dev:code> <dev:remarks> <maml:para>Retrieve all modification events for the sensor with ID 1001</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Get-Sensor</maml:linkText> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-Device</maml:linkText> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-Group</maml:linkText> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-Probe</maml:linkText> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Get-NotificationAction --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-NotificationAction</command:name> <command:verb>Get</command:verb> <command:noun>NotificationAction</command:noun> <maml:description> <maml:para>Retrieves all Notification Actions from a PRTG Server.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Get-NotificationAction retrieves notification actions present on a PRTG Server. Notification actions can be triggered under various circumstances via notification triggers. For more information on notification triggers, see Get-NotificationTrigger.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Get-NotificationAction</maml:name> <!-- Parameter: Name --> <command:parameter required="false" globbing="false" pipelineInput="false" position="0"> <maml:name>Name</maml:name> <maml:description> <maml:para>Filter the response to objects with a certain name. Can include wildcards.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Name --> <command:parameter required="false" globbing="false" pipelineInput="false" position="0"> <maml:name>Name</maml:name> <maml:description> <maml:para>Filter the response to objects with a certain name. Can include wildcards.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <!-- OutputType: NotificationAction --> <command:returnValue> <dev:type> <maml:name>PrtgAPI.NotificationAction</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>C:\> Get-NotificationTrigger</dev:code> <dev:remarks> <maml:para>Get all notification actions.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>C:\> Get-NotificationTrigger *pager*</dev:code> <dev:remarks> <maml:para>Get all notification actions whose name contains "pager"</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Get-NotificationTrigger</maml:linkText> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Add-NotificationTrigger --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Add-NotificationTrigger</command:name> <command:verb>Add</command:verb> <command:noun>NotificationTrigger</command:noun> <maml:description> <maml:para>Adds a notification trigger to a PRTG Server.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Add-NotificationTrigger cmdlet adds a new notification trigger to an object in PRTG. When adding a notification trigger, you must first create a TriggerParameters object that defines the settings to use in the trigger. TriggerParameters can be defined from existing notification triggers or created from scratch. Certain objects do support certain types of notification triggers (e.g. different types of sensors). Attempting to add a notification trigger to an unspecified type will generate an InvalidTriggerTypeException. Notification triggers applied to parent objects that are not supported by their children are simply ignored within PRTG, and do not generate exceptions. For information on viewing the trigger types supported by an object, see Get-NotificationTriggerTypes</maml:para> <maml:para>For more information on creating TriggerParameters , see New-NotificationTriggerParameter.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Add-NotificationTrigger</maml:name> <!-- Parameter: Parameters --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Parameters</maml:name> <maml:description> <maml:para>The parameters to use to add/modify a NotificationTrigger.</maml:para> </maml:description> <command:parameterValue required="true">TriggerParameters</command:parameterValue> <dev:type> <maml:name>PrtgAPI.Parameters.TriggerParameters</maml:name> <maml:uri /> <maml:description> <maml:para>Represents parameters use to construct a PrtgUrl for adding/modifying NotificationTrigger objects.</maml:para> </maml:description> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Parameters --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Parameters</maml:name> <maml:description> <maml:para>The parameters to use to add/modify a NotificationTrigger.</maml:para> </maml:description> <command:parameterValue required="true">TriggerParameters</command:parameterValue> <dev:type> <maml:name>PrtgAPI.Parameters.TriggerParameters</maml:name> <maml:uri /> <maml:description> <maml:para>Represents parameters use to construct a PrtgUrl for adding/modifying NotificationTrigger objects.</maml:para> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>PrtgAPI.Parameters.TriggerParameters</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The parameters to use to add/modify a NotificationTrigger.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>C:\> Get-Probe | Get-NotificationTrigger | New-TriggerParameter 2001 | Add-Trigger</dev:code> <dev:remarks> <maml:para>Add all triggers on all probes directly to the object with ID 2001.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>New-NotificationTriggerParameter</maml:linkText> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-NotificationTrigger</maml:linkText> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Edit-NotificationTriggerProperty</maml:linkText> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Get-NotificationTrigger --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-NotificationTrigger</command:name> <command:verb>Get</command:verb> <command:noun>NotificationTrigger</command:noun> <maml:description> <maml:para>Retrieves notification triggers from a PRTG Server.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Get-NotificationTrigger cmdlet retrieves notification triggers that are defined on a PRTG Object as well as the types of triggers an object supports. Notification triggers define conditions that when met by a sensor or one of its channels, should result in the firing of a notification action. When notification triggers are defined on a device, group, or probe, the triggers are inherited by all nodes under the object. Individual objects can choose to block inheritance of notification triggers, preventing those triggers from trickling down.</maml:para> <maml:para>When looking at notification triggers defined on a single object, Get-NotificationTrigger can be invoked with no arguments. When looking at notification triggers across multiple objects, it is often useful to filter out notification triggers inherited from a parent object via the -Inherited parameter.</maml:para> <maml:para>NotificationTrigger objects returned from Get-NotificationTrigger can be passed to Edit-NotificationTriggerProperty or New-NotificationTriggerParameter, to allow cloning or editing the trigger's properties.</maml:para> <maml:para>Notification trigger types that are supported by a specified object can be determined using the -Types parameter. While there is no restriction on the types of triggers assignable to container-like objects (including devices, groups and probes) each sensor can only be assigned specific types based on the types of channels it contains. When adding a new trigger, Add-NotificationTrigger will automatically validate whether the specified TriggerParameters are assignable to the target object. If the new trigger's type is incompatible with the target object, PrtgAPI will throw an exception alerting you to this error.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: Default --> <command:syntaxItem> <maml:name>Get-NotificationTrigger</maml:name> <!-- Parameter: OnNotificationAction --> <command:parameter required="false" globbing="false" pipelineInput="false" position="0"> <maml:name>OnNotificationAction</maml:name> <maml:description> <maml:para>Filter the response to objects with a certain OnNotificationAction. Can include wildcards.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Object --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Object</maml:name> <maml:description> <maml:para>The object to retrieve notification triggers for.</maml:para> </maml:description> <command:parameterValue required="true">SensorOrDeviceOrGroupOrProbe</command:parameterValue> <dev:type> <maml:name>PrtgAPI.Objects.Shared.SensorOrDeviceOrGroupOrProbe</maml:name> <maml:uri /> <maml:description> <maml:para>Properties that apply to Sensors, Devices, Groups and Probes.</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: Inherited --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Inherited</maml:name> <maml:description> <maml:para>Indicates whether to include inherited triggers in the response.</maml:para> </maml:description> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Type --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Type</maml:name> <maml:description> <maml:para>Filter the response to objects of a certain type.</maml:para> <maml:para>Possible values: State, Speed, Volume, Threshold, Change</maml:para> </maml:description> <command:parameterValue required="true">TriggerType</command:parameterValue> <dev:type> <maml:name>PrtgAPI.TriggerType</maml:name> <maml:uri /> <maml:description> <maml:para>Specifies types of notification triggers that can be defined on objects.</maml:para> </maml:description> </dev:type> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">State</command:parameterValue> <command:parameterValue required="false" variableLength="false">Speed</command:parameterValue> <command:parameterValue required="false" variableLength="false">Volume</command:parameterValue> <command:parameterValue required="false" variableLength="false">Threshold</command:parameterValue> <command:parameterValue required="false" variableLength="false">Change</command:parameterValue> </command:parameterValueGroup> </command:parameter> </command:syntaxItem> <!-- Parameter set: Types --> <command:syntaxItem> <maml:name>Get-NotificationTrigger</maml:name> <!-- Parameter: Object --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Object</maml:name> <maml:description> <maml:para>The object to retrieve notification triggers for.</maml:para> </maml:description> <command:parameterValue required="true">SensorOrDeviceOrGroupOrProbe</command:parameterValue> <dev:type> <maml:name>PrtgAPI.Objects.Shared.SensorOrDeviceOrGroupOrProbe</maml:name> <maml:uri /> <maml:description> <maml:para>Properties that apply to Sensors, Devices, Groups and Probes.</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: Types --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Types</maml:name> <maml:description> <maml:para>List all notification trigger types compatible with the specified object.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Object --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Object</maml:name> <maml:description> <maml:para>The object to retrieve notification triggers for.</maml:para> </maml:description> <command:parameterValue required="true">SensorOrDeviceOrGroupOrProbe</command:parameterValue> <dev:type> <maml:name>PrtgAPI.Objects.Shared.SensorOrDeviceOrGroupOrProbe</maml:name> <maml:uri /> <maml:description> <maml:para>Properties that apply to Sensors, Devices, Groups and Probes.</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: OnNotificationAction --> <command:parameter required="false" globbing="false" pipelineInput="false" position="0"> <maml:name>OnNotificationAction</maml:name> <maml:description> <maml:para>Filter the response to objects with a certain OnNotificationAction. Can include wildcards.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Type --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Type</maml:name> <maml:description> <maml:para>Filter the response to objects of a certain type.</maml:para> <maml:para>Possible values: State, Speed, Volume, Threshold, Change</maml:para> </maml:description> <command:parameterValue required="true">TriggerType</command:parameterValue> <dev:type> <maml:name>PrtgAPI.TriggerType</maml:name> <maml:uri /> <maml:description> <maml:para>Specifies types of notification triggers that can be defined on objects.</maml:para> </maml:description> </dev:type> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">State</command:parameterValue> <command:parameterValue required="false" variableLength="false">Speed</command:parameterValue> <command:parameterValue required="false" variableLength="false">Volume</command:parameterValue> <command:parameterValue required="false" variableLength="false">Threshold</command:parameterValue> <command:parameterValue required="false" variableLength="false">Change</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: Types --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Types</maml:name> <maml:description> <maml:para>List all notification trigger types compatible with the specified object.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Inherited --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Inherited</maml:name> <maml:description> <maml:para>Indicates whether to include inherited triggers in the response.</maml:para> </maml:description> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>PrtgAPI.Objects.Shared.SensorOrDeviceOrGroupOrProbe</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The object to retrieve notification triggers for.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: NotificationTrigger --> <command:returnValue> <dev:type> <maml:name>PrtgAPI.NotificationTrigger</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Causes notification actions to occur when a sensor exhibits a specified behaviour.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>Get-Probe | Get-NotificationTrigger</dev:code> <dev:remarks> <maml:para>Get all notification triggers defined on all probes</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>Get-Device | Get-NotificationTrigger *pager* -Inherited $false</dev:code> <dev:remarks> <maml:para>Get all notification triggers from all devices whose OnNotificationAction action name contains "pager" in the name and are not inherited from any parent objects.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 3 ----------</maml:title> <dev:code>Get-Probe -Id 2001 | Get-NotificationTrigger -Type State</dev:code> <dev:remarks> <maml:para>Get all State notification triggers from the sensor with ID 2001</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 4 ----------</maml:title> <dev:code>Get-Sensor -Id 1001 | Get-NotificationTrigger -Types</dev:code> <dev:remarks> <maml:para>Get all notification trigger types supported by the object with ID 1001.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Get-Sensor</maml:linkText> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-Device</maml:linkText> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-Group</maml:linkText> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-Probe</maml:linkText> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Add-NotificationTrigger</maml:linkText> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-NotificationTriggerParameter</maml:linkText> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-NotificationTrigger</maml:linkText> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Edit-NotificationTriggerProperty</maml:linkText> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Remove-NotificationTrigger --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Remove-NotificationTrigger</command:name> <command:verb>Remove</command:verb> <command:noun>NotificationTrigger</command:noun> <maml:description> <maml:para>Removes a notification trigger from a PRTG Object.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Remove-NotificationTrigger cmdlet removes a notification trigger from a PRTG Object. Notification triggers can only be removed from the objects on which they are explicitly defined. Attempting to remove a notification trigger from an object which inherits the trigger from its parent will generate an exception.</maml:para> <maml:para>If invoked with no arguments other than the notification trigger to be deleted, Remove-NotificationTrigger will prompt for confirmation of each trigger to be deleted. If you wish to remove multiple triggers, it is recommended to first run Remove-NotificationTrigger with the -WhatIf parameter, and then re-run with the -Force parameter if the results of -WhatIf look correct</maml:para> <maml:para>When invoked with -WhatIf, Remove-NotificationTrigger will list all notification triggers that would have been removed, along with the OnNotificationAction and Sub ID of the notification trigger and the object ID of the object to which the triggers are applied. Even if you are sure of the triggers you wish to delete, it is recommended to always run with -WhatIf first to confirm you have specified the correct triggers and that PrtgAPI has interpreted your request in the way you intended.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Remove-NotificationTrigger</maml:name> <!-- Parameter: Trigger --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Trigger</maml:name> <maml:description> <maml:para>Notification trigger to remove.</maml:para> </maml:description> <command:parameterValue required="true">NotificationTrigger</command:parameterValue> <dev:type> <maml:name>PrtgAPI.NotificationTrigger</maml:name> <maml:uri /> <maml:description> <maml:para>Causes notification actions to occur when a sensor exhibits a specified behaviour.</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: Force --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Forces a notification trigger to be removed without displaying a confirmation prompt.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Trigger --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Trigger</maml:name> <maml:description> <maml:para>Notification trigger to remove.</maml:para> </maml:description> <command:parameterValue required="true">NotificationTrigger</command:parameterValue> <dev:type> <maml:name>PrtgAPI.NotificationTrigger</maml:name> <maml:uri /> <maml:description> <maml:para>Causes notification actions to occur when a sensor exhibits a specified behaviour.</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: Force --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Forces a notification trigger to be removed without displaying a confirmation prompt.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>PrtgAPI.NotificationTrigger</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Notification trigger to remove.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>C:\> Get-Device dc-1 | Get-NotificationTrigger | Remove-NotificationTrigger -WhatIf</dev:code> <dev:remarks> <maml:para>"What if: Performing operation "Remove-NotificationTrigger" on target "'Email to Administrator' (Object ID: 2002, Sub ID: 1)""</maml:para> <maml:para>Preview what will happen when you attempt all triggers from all devices with the name 'dc-1'</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>C:\> Get-Device dc-1 | Get-NotificationTrigger | Remove-NotificationTrigger -Force</dev:code> <dev:remarks> <maml:para>Remove all notification triggers from devices named 'dc-1' without prompting for confirmation.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Get-NotificationTrigger</maml:linkText> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Set-NotificationTrigger --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Set-NotificationTrigger</command:name> <command:verb>Set</command:verb> <command:noun>NotificationTrigger</command:noun> <maml:description> <maml:para>Add or modify a notification trigger on a PRTG Server.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Set-NotificationTrigger cmdlet updates an existing notification trigger defined on an object in PRTG. When editing a notification trigger, you must first create a TriggerParameters object that defines the settings you wish to modify. TriggerParameters can be created from an existing notification trigger or created from scratch.</maml:para> <maml:para>For more information on creating TriggerParameters, see New-NotificationTriggerParameter</maml:para> <maml:para>For information on how to quickly edit a single trigger property, see Edit-NotificationTriggerProperty.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Set-NotificationTrigger</maml:name> <!-- Parameter: Parameters --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Parameters</maml:name> <maml:description> <maml:para>The parameters to use to add/modify a NotificationTrigger.</maml:para> </maml:description> <command:parameterValue required="true">TriggerParameters</command:parameterValue> <dev:type> <maml:name>PrtgAPI.Parameters.TriggerParameters</maml:name> <maml:uri /> <maml:description> <maml:para>Represents parameters use to construct a PrtgUrl for adding/modifying NotificationTrigger objects.</maml:para> </maml:description> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Parameters --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Parameters</maml:name> <maml:description> <maml:para>The parameters to use to add/modify a NotificationTrigger.</maml:para> </maml:description> <command:parameterValue required="true">TriggerParameters</command:parameterValue> <dev:type> <maml:name>PrtgAPI.Parameters.TriggerParameters</maml:name> <maml:uri /> <maml:description> <maml:para>Represents parameters use to construct a PrtgUrl for adding/modifying NotificationTrigger objects.</maml:para> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>PrtgAPI.Parameters.TriggerParameters</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The parameters to use to add/modify a NotificationTrigger.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <maml:introduction> <maml:para>C:\> $triggerParams = Get-Probe | Get-Trigger -Type State | New-TriggerParameter</maml:para> <maml:para>C:\> $triggerParams.RepeatInterval = 20</maml:para> <maml:para>C:\> $triggerParams.OffNotificationAction = $null</maml:para> <maml:para>C:\> $triggerParams | Set-NotificationTrigger</maml:para> </maml:introduction> <dev:code></dev:code> <dev:remarks> <maml:para>Set the repeat interval of the notification to trigger to every 20 minutes, and remove the off notification action. This example assumes there is exactly one probe in the system with exactly one state notification trigger defined on it.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>New-NotificationTriggerParameter</maml:linkText> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Edit-NotificationTriggerProperty</maml:linkText> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: New-NotificationTriggerParameter --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>New-NotificationTriggerParameter</command:name> <command:verb>New</command:verb> <command:noun>NotificationTriggerParameter</command:noun> <maml:description> <maml:para>Creates a new set of notification trigger parameters for adding or editing a notification trigger.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The New-NotificationTriggerParameter cmdlet creates a set of trigger parameters for creating or editing a notification trigger. When editing notification triggers, New-NotificationTriggerParameter should only be used when multiple values require updating. For updating a single notification trigger property Edit-NotificationTriggerProperty should be used instead.</maml:para> <maml:para>When creating a new notification trigger, the trigger's parameters can either be imported from an existing notification trigger's properties and then further modified, or defined manually from scratch.</maml:para> <maml:para>Based on the type of notification trigger specified, New-NotificationTriggerParameter will create one of several TriggerParameter type objects, exposing only the parameters relevant to that trigger type.</maml:para> <maml:para>When working with TriggerParameters objects, all parameter properties support nullable values, allowing you to clear any properties you wish to remove or undo. The exception to this however is Notification Action related properties. When a Notification Action is set to null, it will set the property to the "empty" notification action. This allows you to easily clear unwanted notification actions within the PRTG Interface.</maml:para> <maml:para>When editing existing notification triggers, all properties on the TriggerParameters object will be initially set to null. Specifying a value for a property will highlight to PrtgAPI that that property should be updated when the trigger request is executed. While holding a value of null by default, Notification Actions will not set themselves with the "empty" notification action unless this value is explicitly specified. Note that if you wish to undo modifying a notification action property you have set to null, you will be unable to do so without creating a brand new TriggerParameters object.</maml:para> <maml:para>For trigger types where the Channel property is supported (Speed, Threshold and Volume) when defining the trigger on a Probe, Group or Device, enum values "Primary", "Total", "TrafficIn" and "TrafficOut" must be used. When applied directly to a Sensor, a specific Channel or Channel ID must be used. To safely resolve all channels supported by the sensor the Get-Channel cmdlet can be used. Once a Channel or Channel ID has been assigned to a trigger parameter's Channel property, it is wrapped as a TriggerChannel object and the underlying type cannot be retrieved. As such, if you wish to refer to your original type, you must keep a copy of the value assigned to the Channel property for further use in your code.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: Add --> <command:syntaxItem> <maml:name>New-NotificationTriggerParameter</maml:name> <!-- Parameter: Id --> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>Id</maml:name> <maml:description> <maml:para>The ID of the object the notification trigger will be created for.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Type --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>Type</maml:name> <maml:description> <maml:para>The type of notification trigger to manipulate.</maml:para> <maml:para>Possible values: State, Speed, Volume, Threshold, Change</maml:para> </maml:description> <command:parameterValue required="true">TriggerType</command:parameterValue> <dev:type> <maml:name>PrtgAPI.TriggerType</maml:name> <maml:uri /> <maml:description> <maml:para>Specifies types of notification triggers that can be defined on objects.</maml:para> </maml:description> </dev:type> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">State</command:parameterValue> <command:parameterValue required="false" variableLength="false">Speed</command:parameterValue> <command:parameterValue required="false" variableLength="false">Volume</command:parameterValue> <command:parameterValue required="false" variableLength="false">Threshold</command:parameterValue> <command:parameterValue required="false" variableLength="false">Change</command:parameterValue> </command:parameterValueGroup> </command:parameter> </command:syntaxItem> <!-- Parameter set: Edit --> <command:syntaxItem> <maml:name>New-NotificationTriggerParameter</maml:name> <!-- Parameter: Id --> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>Id</maml:name> <maml:description> <maml:para>The ID of the object the notification trigger will be created for.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: TriggerId --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>TriggerId</maml:name> <maml:description> <maml:para>The Sub ID of the trigger to manipulate.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Type --> <command:parameter required="true" globbing="false" pipelineInput="false" position="2"> <maml:name>Type</maml:name> <maml:description> <maml:para>The type of notification trigger to manipulate.</maml:para> <maml:para>Possible values: State, Speed, Volume, Threshold, Change</maml:para> </maml:description> <command:parameterValue required="true">TriggerType</command:parameterValue> <dev:type> <maml:name>PrtgAPI.TriggerType</maml:name> <maml:uri /> <maml:description> <maml:para>Specifies types of notification triggers that can be defined on objects.</maml:para> </maml:description> </dev:type> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">State</command:parameterValue> <command:parameterValue required="false" variableLength="false">Speed</command:parameterValue> <command:parameterValue required="false" variableLength="false">Volume</command:parameterValue> <command:parameterValue required="false" variableLength="false">Threshold</command:parameterValue> <command:parameterValue required="false" variableLength="false">Change</command:parameterValue> </command:parameterValueGroup> </command:parameter> </command:syntaxItem> <!-- Parameter set: AddFrom --> <command:syntaxItem> <maml:name>New-NotificationTriggerParameter</maml:name> <!-- Parameter: Id --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>Id</maml:name> <maml:description> <maml:para>The ID of the object the notification trigger will be created for.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Source --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Source</maml:name> <maml:description> <maml:para>The notification trigger import trigger parameters from.</maml:para> </maml:description> <command:parameterValue required="true">NotificationTrigger</command:parameterValue> <dev:type> <maml:name>PrtgAPI.NotificationTrigger</maml:name> <maml:uri /> <maml:description> <maml:para>Causes notification actions to occur when a sensor exhibits a specified behaviour.</maml:para> </maml:description> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: EditFrom --> <command:syntaxItem> <maml:name>New-NotificationTriggerParameter</maml:name> <!-- Parameter: Source --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Source</maml:name> <maml:description> <maml:para>The notification trigger import trigger parameters from.</maml:para> </maml:description> <command:parameterValue required="true">NotificationTrigger</command:parameterValue> <dev:type> <maml:name>PrtgAPI.NotificationTrigger</maml:name> <maml:uri /> <maml:description> <maml:para>Causes notification actions to occur when a sensor exhibits a specified behaviour.</maml:para> </maml:description> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Id --> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>Id</maml:name> <maml:description> <maml:para>The ID of the object the notification trigger will be created for.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Source --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Source</maml:name> <maml:description> <maml:para>The notification trigger import trigger parameters from.</maml:para> </maml:description> <command:parameterValue required="true">NotificationTrigger</command:parameterValue> <dev:type> <maml:name>PrtgAPI.NotificationTrigger</maml:name> <maml:uri /> <maml:description> <maml:para>Causes notification actions to occur when a sensor exhibits a specified behaviour.</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: TriggerId --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>TriggerId</maml:name> <maml:description> <maml:para>The Sub ID of the trigger to manipulate.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Type --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>Type</maml:name> <maml:description> <maml:para>The type of notification trigger to manipulate.</maml:para> <maml:para>Possible values: State, Speed, Volume, Threshold, Change</maml:para> </maml:description> <command:parameterValue required="true">TriggerType</command:parameterValue> <dev:type> <maml:name>PrtgAPI.TriggerType</maml:name> <maml:uri /> <maml:description> <maml:para>Specifies types of notification triggers that can be defined on objects.</maml:para> </maml:description> </dev:type> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">State</command:parameterValue> <command:parameterValue required="false" variableLength="false">Speed</command:parameterValue> <command:parameterValue required="false" variableLength="false">Volume</command:parameterValue> <command:parameterValue required="false" variableLength="false">Threshold</command:parameterValue> <command:parameterValue required="false" variableLength="false">Change</command:parameterValue> </command:parameterValueGroup> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The ID of the object the notification trigger will be created for.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>PrtgAPI.NotificationTrigger</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The notification trigger import trigger parameters from.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: TriggerParameters --> <command:returnValue> <dev:type> <maml:name>PrtgAPI.Parameters.TriggerParameters</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Represents parameters use to construct a PrtgUrl for adding/modifying NotificationTrigger objects.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>C:\> $param = New-TriggerParameter 1234 State</dev:code> <dev:remarks> <maml:para>C:\> $param | Add-Trigger</maml:para> <maml:para>Add a new state notification trigger with default values to object with ID 1234</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>C:\> $param = New-TriggerParameter 1234 3 State</dev:code> <dev:remarks> <maml:para>C:\> $param.Latency = 40</maml:para> <maml:para>C:\> $param | Set-Trigger</maml:para> <maml:para>Edit the state notification trigger with sub ID 3 on the object with ID 1234, setting the Latency to 40 seconds</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 3 ----------</maml:title> <dev:code>C:\> $param = Get-Sensor -Id 1001 | Get-Trigger -Type State -Inherited $false | New-TriggerParameter 1234</dev:code> <dev:remarks> <maml:para>C:\> $param.OffNotificationAction = $null</maml:para> <maml:para>C:\> $param | Add-Trigger</maml:para> <maml:para>Create a new notification trigger on the object with ID 1234 from the state trigger on the sensor with ID 1001, setting the OffNotificationAction to "None"</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 4 ----------</maml:title> <dev:code>C:\> $param = Get-Sensor -Id 1001 | Get-Trigger -Type State -Inherited $false | New-TriggerParameter</dev:code> <dev:remarks> <maml:para>C:\> $param.Latency = 30</maml:para> <maml:para>C:\> $param | Set-Trigger</maml:para> <maml:para>Edit the notification trigger on the sensor with ID 1001, setting the latency to 30 seconds</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 5 ----------</maml:title> <dev:code>C:\> $sensor = Get-Sensor -Id 1001</dev:code> <dev:remarks> <maml:para>C:\> $channel = $sensor | Get-Channel "Available Memory"</maml:para> <maml:para>C:\> $param = New-TriggerParameter $sensor.Id Threshold</maml:para> <maml:para>C:\> $param.Channel = $channel</maml:para> <maml:para>C:\> $param | Add-Trigger</maml:para> <maml:para>Create a new notification trigger on the sensor with ID 1001 that alerts based on the value of its "Available Memory" channel.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 6 ----------</maml:title> <dev:code>C:\> $param = New-TriggerParameter 1001 Threshold</dev:code> <dev:remarks> <maml:para>C:\> $param.Channel = 1</maml:para> <maml:para>C:\> $param | Add-Trigger</maml:para> <maml:para>Create a new threshold notification trigger on the sensor with ID 1001 that alerts based on the value of the channel with ID 1.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Edit-NotificationTriggerProperty</maml:linkText> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Add-NotificationTrigger</maml:linkText> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-NotificationTrigger</maml:linkText> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-Channel</maml:linkText> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Edit-NotificationTriggerProperty --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Edit-NotificationTriggerProperty</command:name> <command:verb>Edit</command:verb> <command:noun>NotificationTriggerProperty</command:noun> <maml:description> <maml:para>Edits a notification trigger on a PRTG Server.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Edit-NotificationTriggerProperty</maml:name> <!-- Parameter: Property --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>Property</maml:name> <maml:description> <maml:para>The property to modify.</maml:para> <maml:para>Possible values: State, Latency, OnNotificationAction, OffNotificationAction, EscalationNotificationAction, EscalationLatency, RepeatInterval, Channel, Period, UnitSize, Condition, Threshold, UnitTime</maml:para> </maml:description> <command:parameterValue required="true">TriggerProperty</command:parameterValue> <dev:type> <maml:name>PrtgAPI.TriggerProperty</maml:name> <maml:uri /> <maml:description> <maml:para>Specifies properties that can be modified on notification triggers.</maml:para> </maml:description> </dev:type> <dev:defaultValue>State</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">State</command:parameterValue> <command:parameterValue required="false" variableLength="false">Latency</command:parameterValue> <command:parameterValue required="false" variableLength="false">OnNotificationAction</command:parameterValue> <command:parameterValue required="false" variableLength="false">OffNotificationAction</command:parameterValue> <command:parameterValue required="false" variableLength="false">EscalationNotificationAction</command:parameterValue> <command:parameterValue required="false" variableLength="false">EscalationLatency</command:parameterValue> <command:parameterValue required="false" variableLength="false">RepeatInterval</command:parameterValue> <command:parameterValue required="false" variableLength="false">Channel</command:parameterValue> <command:parameterValue required="false" variableLength="false">Period</command:parameterValue> <command:parameterValue required="false" variableLength="false">UnitSize</command:parameterValue> <command:parameterValue required="false" variableLength="false">Condition</command:parameterValue> <command:parameterValue required="false" variableLength="false">Threshold</command:parameterValue> <command:parameterValue required="false" variableLength="false">UnitTime</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: Value --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Value</maml:name> <maml:description> <maml:para>Value to set the property to.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Trigger --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Trigger</maml:name> <maml:description> <maml:para>Notification Trigger to edit.</maml:para> </maml:description> <command:parameterValue required="true">NotificationTrigger</command:parameterValue> <dev:type> <maml:name>PrtgAPI.NotificationTrigger</maml:name> <maml:uri /> <maml:description> <maml:para>Causes notification actions to occur when a sensor exhibits a specified behaviour.</maml:para> </maml:description> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Trigger --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Trigger</maml:name> <maml:description> <maml:para>Notification Trigger to edit.</maml:para> </maml:description> <command:parameterValue required="true">NotificationTrigger</command:parameterValue> <dev:type> <maml:name>PrtgAPI.NotificationTrigger</maml:name> <maml:uri /> <maml:description> <maml:para>Causes notification actions to occur when a sensor exhibits a specified behaviour.</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: Property --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>Property</maml:name> <maml:description> <maml:para>The property to modify.</maml:para> <maml:para>Possible values: State, Latency, OnNotificationAction, OffNotificationAction, EscalationNotificationAction, EscalationLatency, RepeatInterval, Channel, Period, UnitSize, Condition, Threshold, UnitTime</maml:para> </maml:description> <command:parameterValue required="true">TriggerProperty</command:parameterValue> <dev:type> <maml:name>PrtgAPI.TriggerProperty</maml:name> <maml:uri /> <maml:description> <maml:para>Specifies properties that can be modified on notification triggers.</maml:para> </maml:description> </dev:type> <dev:defaultValue>State</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">State</command:parameterValue> <command:parameterValue required="false" variableLength="false">Latency</command:parameterValue> <command:parameterValue required="false" variableLength="false">OnNotificationAction</command:parameterValue> <command:parameterValue required="false" variableLength="false">OffNotificationAction</command:parameterValue> <command:parameterValue required="false" variableLength="false">EscalationNotificationAction</command:parameterValue> <command:parameterValue required="false" variableLength="false">EscalationLatency</command:parameterValue> <command:parameterValue required="false" variableLength="false">RepeatInterval</command:parameterValue> <command:parameterValue required="false" variableLength="false">Channel</command:parameterValue> <command:parameterValue required="false" variableLength="false">Period</command:parameterValue> <command:parameterValue required="false" variableLength="false">UnitSize</command:parameterValue> <command:parameterValue required="false" variableLength="false">Condition</command:parameterValue> <command:parameterValue required="false" variableLength="false">Threshold</command:parameterValue> <command:parameterValue required="false" variableLength="false">UnitTime</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: Value --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Value</maml:name> <maml:description> <maml:para>Value to set the property to.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>PrtgAPI.NotificationTrigger</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Notification Trigger to edit.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> </command:command> <!-- Cmdlet: Move-Object --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Move-Object</command:name> <command:verb>Move</command:verb> <command:noun>Object</command:noun> <maml:description> <maml:para>Moves a device or group within the PRTG Object Tree.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter set: Device --> <command:syntaxItem> <maml:name>Move-Object</maml:name> <!-- Parameter: DestinationId --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>DestinationId</maml:name> <maml:description> <maml:para>The group or probe to move the object to. This cannot be the Root PRTG Group.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: Device --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Device</maml:name> <maml:description> <maml:para>The device to move to another group or probe.</maml:para> </maml:description> <command:parameterValue required="true">Device</command:parameterValue> <dev:type> <maml:name>PrtgAPI.Device</maml:name> <maml:uri /> <maml:description> <maml:para>A computer or piece of equipment containing one or more sensors monitored by PRTG.</maml:para> </maml:description> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: Group --> <command:syntaxItem> <maml:name>Move-Object</maml:name> <!-- Parameter: DestinationId --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>DestinationId</maml:name> <maml:description> <maml:para>The group or probe to move the object to. This cannot be the Root PRTG Group.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: Group --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Group</maml:name> <maml:description> <maml:para>The group to move to another group or probe.</maml:para> </maml:description> <command:parameterValue required="true">Group</command:parameterValue> <dev:type> <maml:name>PrtgAPI.Group</maml:name> <maml:uri /> <maml:description> <maml:para>A group used to organize one or more devices.</maml:para> </maml:description> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Device --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Device</maml:name> <maml:description> <maml:para>The device to move to another group or probe.</maml:para> </maml:description> <command:parameterValue required="true">Device</command:parameterValue> <dev:type> <maml:name>PrtgAPI.Device</maml:name> <maml:uri /> <maml:description> <maml:para>A computer or piece of equipment containing one or more sensors monitored by PRTG.</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: Group --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Group</maml:name> <maml:description> <maml:para>The group to move to another group or probe.</maml:para> </maml:description> <command:parameterValue required="true">Group</command:parameterValue> <dev:type> <maml:name>PrtgAPI.Group</maml:name> <maml:uri /> <maml:description> <maml:para>A group used to organize one or more devices.</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: DestinationId --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>DestinationId</maml:name> <maml:description> <maml:para>The group or probe to move the object to. This cannot be the Root PRTG Group.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>PrtgAPI.Device</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The device to move to another group or probe.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>PrtgAPI.Group</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The group to move to another group or probe.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> </command:command> <!-- Cmdlet: Remove-Object --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Remove-Object</command:name> <command:verb>Remove</command:verb> <command:noun>Object</command:noun> <maml:description> <maml:para>Permanently removes an object from PRTG.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Remove-Object cmdlet permanently removes an object from PRTG. Some objects cannot be deleted (e.g. the root PRTG group (ID 0) and will generate an exception if you attempt to do so.</maml:para> <maml:para>If invoked with no arguments other than the object to be deleted, Remove-Object will prompt for confirmation of each object to be deleted. If you wish to delete multiple objects, it is recommend to first run Remove-Object with the -WhatIf parameter, and then re-run with the -Force parameter if the results of -WhatIf look correct.</maml:para> <maml:para>When invoked with -WhatIf, Remove-Object will list all objects that would have been deleted, along with their corresponding object IDs. Even if you are sure of the objects you wish to delete, it is recommended to always run with -WhatIf first to confirm you have specified the correct objects and that PrtgAPI has interpreted your request in the way you intended.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Remove-Object</maml:name> <!-- Parameter: Object --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Object</maml:name> <maml:description> <maml:para>The object to remove.</maml:para> </maml:description> <command:parameterValue required="true">SensorOrDeviceOrGroupOrProbe</command:parameterValue> <dev:type> <maml:name>PrtgAPI.Objects.Shared.SensorOrDeviceOrGroupOrProbe</maml:name> <maml:uri /> <maml:description> <maml:para>Properties that apply to Sensors, Devices, Groups and Probes.</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: Force --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Forces an object to be removed without displaying a confirmation prompt.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Object --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Object</maml:name> <maml:description> <maml:para>The object to remove.</maml:para> </maml:description> <command:parameterValue required="true">SensorOrDeviceOrGroupOrProbe</command:parameterValue> <dev:type> <maml:name>PrtgAPI.Objects.Shared.SensorOrDeviceOrGroupOrProbe</maml:name> <maml:uri /> <maml:description> <maml:para>Properties that apply to Sensors, Devices, Groups and Probes.</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: Force --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Forces an object to be removed without displaying a confirmation prompt.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>PrtgAPI.Objects.Shared.SensorOrDeviceOrGroupOrProbe</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The object to remove.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>C:\> Get-Device dc-1 | Remove-Object -WhatIf</dev:code> <dev:remarks> <maml:para>"What if: Performing the operation "Remove-Object" on target "'dc-1' (ID: 2001)""</maml:para> <maml:para>Preview what will happen when you attempt to remove all devices named 'dc-1'</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>C:\> Get-Device dc-1 | Remove-Object -Force</dev:code> <dev:remarks> <maml:para>Remove all devices with name 'dc-1' without prompting for confirmation.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Get-Sensor</maml:linkText> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-Device</maml:linkText> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-Group</maml:linkText> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-Probe</maml:linkText> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Rename-Object --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Rename-Object</command:name> <command:verb>Rename</command:verb> <command:noun>Object</command:noun> <maml:description> <maml:para>Renames a PRTG object.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Rename-Object</maml:name> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>Name</maml:name> <maml:description> <maml:para>The new name to give the object.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Object --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Object</maml:name> <maml:description> <maml:para>The object to rename.</maml:para> </maml:description> <command:parameterValue required="true">SensorOrDeviceOrGroupOrProbe</command:parameterValue> <dev:type> <maml:name>PrtgAPI.Objects.Shared.SensorOrDeviceOrGroupOrProbe</maml:name> <maml:uri /> <maml:description> <maml:para>Properties that apply to Sensors, Devices, Groups and Probes.</maml:para> </maml:description> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Object --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Object</maml:name> <maml:description> <maml:para>The object to rename.</maml:para> </maml:description> <command:parameterValue required="true">SensorOrDeviceOrGroupOrProbe</command:parameterValue> <dev:type> <maml:name>PrtgAPI.Objects.Shared.SensorOrDeviceOrGroupOrProbe</maml:name> <maml:uri /> <maml:description> <maml:para>Properties that apply to Sensors, Devices, Groups and Probes.</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>Name</maml:name> <maml:description> <maml:para>The new name to give the object.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>PrtgAPI.Objects.Shared.SensorOrDeviceOrGroupOrProbe</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The object to rename.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>Get-Sensor Memory | Rename-Object "Memory Free"</dev:code> <dev:remarks> <maml:para>Rename all objects named "Memory" (case insensitive) to "Memory Free"</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>Get-Sensor Memory | Rename-Object "Memory Free" -WhatIf</dev:code> <dev:remarks> <maml:para>What if: Performing the operation "Rename-Object" on target "'Memory' (ID: 2001)"</maml:para> <maml:para>Preview what will happen when you attempt to rename all objects named "Memory"</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Get-Sensor</maml:linkText> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-Device</maml:linkText> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-Group</maml:linkText> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-Probe</maml:linkText> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Resume-Object --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Resume-Object</command:name> <command:verb>Resume</command:verb> <command:noun>Object</command:noun> <maml:description> <maml:para>Resumes an object from a paused or simulated error state.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Resume-Object cmdlet resumes monitoring an object that has previously been interrupted due to manually pausing or simulating an error state on the object.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Resume-Object</maml:name> <!-- Parameter: Object --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Object</maml:name> <maml:description> <maml:para>The object to resume.</maml:para> </maml:description> <command:parameterValue required="true">SensorOrDeviceOrGroupOrProbe</command:parameterValue> <dev:type> <maml:name>PrtgAPI.Objects.Shared.SensorOrDeviceOrGroupOrProbe</maml:name> <maml:uri /> <maml:description> <maml:para>Properties that apply to Sensors, Devices, Groups and Probes.</maml:para> </maml:description> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Object --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Object</maml:name> <maml:description> <maml:para>The object to resume.</maml:para> </maml:description> <command:parameterValue required="true">SensorOrDeviceOrGroupOrProbe</command:parameterValue> <dev:type> <maml:name>PrtgAPI.Objects.Shared.SensorOrDeviceOrGroupOrProbe</maml:name> <maml:uri /> <maml:description> <maml:para>Properties that apply to Sensors, Devices, Groups and Probes.</maml:para> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>PrtgAPI.Objects.Shared.SensorOrDeviceOrGroupOrProbe</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The object to resume.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Get-Sensor</maml:linkText> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-Device</maml:linkText> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-Group</maml:linkText> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-Probe</maml:linkText> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Suspend-Object --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Suspend-Object</command:name> <command:verb>Suspend</command:verb> <command:noun>Object</command:noun> <maml:description> <maml:para>Disables monitoring on an object.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Pause-Object cmdlet disables monitoring of an object in PRTG. When an object is paused, all children of the object are paused as well. Child objects can be independently paused and unpaused while their parent is paused, however their states will not modify as long as their parent is overriding them.</maml:para> <maml:para>When pausing an object, you must specify how long to pause the object for. While in a paused state PRTG will not attempt to execute any sensor objects covered by the paused object.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: Default --> <command:syntaxItem> <maml:name>Suspend-Object</maml:name> <!-- Parameter: Duration --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Duration</maml:name> <maml:description> <maml:para>The duration to pause the object for, in minutes.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Object --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Object</maml:name> <maml:description> <maml:para>The object to pause.</maml:para> </maml:description> <command:parameterValue required="true">SensorOrDeviceOrGroupOrProbe</command:parameterValue> <dev:type> <maml:name>PrtgAPI.Objects.Shared.SensorOrDeviceOrGroupOrProbe</maml:name> <maml:uri /> <maml:description> <maml:para>Properties that apply to Sensors, Devices, Groups and Probes.</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: Message --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Message</maml:name> <maml:description> <maml:para>A message to display on the object indicating the reason it is paused.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: Until --> <command:syntaxItem> <maml:name>Suspend-Object</maml:name> <!-- Parameter: Object --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Object</maml:name> <maml:description> <maml:para>The object to pause.</maml:para> </maml:description> <command:parameterValue required="true">SensorOrDeviceOrGroupOrProbe</command:parameterValue> <dev:type> <maml:name>PrtgAPI.Objects.Shared.SensorOrDeviceOrGroupOrProbe</maml:name> <maml:uri /> <maml:description> <maml:para>Properties that apply to Sensors, Devices, Groups and Probes.</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: Until --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Until</maml:name> <maml:description> <maml:para>The datetime at which the object should be unpaused.</maml:para> </maml:description> <command:parameterValue required="true">DateTime</command:parameterValue> <dev:type> <maml:name>System.DateTime</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Message --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Message</maml:name> <maml:description> <maml:para>A message to display on the object indicating the reason it is paused.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: Forever --> <command:syntaxItem> <maml:name>Suspend-Object</maml:name> <!-- Parameter: Forever --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Forever</maml:name> <maml:description> <maml:para>Indicates the object should be paused indefinitely.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Object --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Object</maml:name> <maml:description> <maml:para>The object to pause.</maml:para> </maml:description> <command:parameterValue required="true">SensorOrDeviceOrGroupOrProbe</command:parameterValue> <dev:type> <maml:name>PrtgAPI.Objects.Shared.SensorOrDeviceOrGroupOrProbe</maml:name> <maml:uri /> <maml:description> <maml:para>Properties that apply to Sensors, Devices, Groups and Probes.</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: Message --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Message</maml:name> <maml:description> <maml:para>A message to display on the object indicating the reason it is paused.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Object --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Object</maml:name> <maml:description> <maml:para>The object to pause.</maml:para> </maml:description> <command:parameterValue required="true">SensorOrDeviceOrGroupOrProbe</command:parameterValue> <dev:type> <maml:name>PrtgAPI.Objects.Shared.SensorOrDeviceOrGroupOrProbe</maml:name> <maml:uri /> <maml:description> <maml:para>Properties that apply to Sensors, Devices, Groups and Probes.</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: Message --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Message</maml:name> <maml:description> <maml:para>A message to display on the object indicating the reason it is paused.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Duration --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Duration</maml:name> <maml:description> <maml:para>The duration to pause the object for, in minutes.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Until --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Until</maml:name> <maml:description> <maml:para>The datetime at which the object should be unpaused.</maml:para> </maml:description> <command:parameterValue required="true">DateTime</command:parameterValue> <dev:type> <maml:name>System.DateTime</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Forever --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Forever</maml:name> <maml:description> <maml:para>Indicates the object should be paused indefinitely.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>PrtgAPI.Objects.Shared.SensorOrDeviceOrGroupOrProbe</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The object to pause.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>C:\> Get-Sensor -Id 2001 | Pause-Object -Duration 60</dev:code> <dev:remarks> <maml:para>Pause the object with ID 2001 for 60 minutes.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>C:\> Get-Probe *chicago* | Pause-Object -Until (Get-Date).AddDays(2) -Message "Office move in progress"</dev:code> <dev:remarks> <maml:para>Pause all probes whose names contain "chicago" for three days with a message explaining the reason the object was paused.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 3 ----------</maml:title> <dev:code>C:\> Get-Device fw-1 | Pause-Object -Forever -Message "Decomissioning"</dev:code> <dev:remarks> <maml:para>Pause all devices named "fw-1" forever with a message explaining the reason the object was paused.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Resume-Object</maml:linkText> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Update-Object --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Update-Object</command:name> <command:verb>Update</command:verb> <command:noun>Object</command:noun> <maml:description> <maml:para>Requests an object and any if its children refresh themselves immediately.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Refresh-Object cmdlet causes an object to refresh itself. Sensor objects automatically refresh according to their Scanning Interval. Refresh-Object allows you to bypass this interval and request the sensor update immediately. If Refresh-Object is applied to a Device, Group or Probe, all sensors under that object will be refreshed.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Update-Object</maml:name> <!-- Parameter: Object --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Object</maml:name> <maml:description> <maml:para>The object to refresh.</maml:para> </maml:description> <command:parameterValue required="true">SensorOrDeviceOrGroupOrProbe</command:parameterValue> <dev:type> <maml:name>PrtgAPI.Objects.Shared.SensorOrDeviceOrGroupOrProbe</maml:name> <maml:uri /> <maml:description> <maml:para>Properties that apply to Sensors, Devices, Groups and Probes.</maml:para> </maml:description> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Object --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Object</maml:name> <maml:description> <maml:para>The object to refresh.</maml:para> </maml:description> <command:parameterValue required="true">SensorOrDeviceOrGroupOrProbe</command:parameterValue> <dev:type> <maml:name>PrtgAPI.Objects.Shared.SensorOrDeviceOrGroupOrProbe</maml:name> <maml:uri /> <maml:description> <maml:para>Properties that apply to Sensors, Devices, Groups and Probes.</maml:para> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>PrtgAPI.Objects.Shared.SensorOrDeviceOrGroupOrProbe</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The object to refresh.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>Get-Sensor -Id 2001 | Refresh-Object</dev:code> <dev:remarks> <maml:para>Refresh the sensor with object ID 2001.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>Get-Device -Id 2000 | Refresh-Object</dev:code> <dev:remarks> <maml:para>Refresh all sensors under the device with ID 2000.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Get-Sensor</maml:linkText> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-Device</maml:linkText> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-Group</maml:linkText> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-Probe</maml:linkText> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Set-ObjectPosition --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Set-ObjectPosition</command:name> <command:verb>Set</command:verb> <command:noun>ObjectPosition</command:noun> <maml:description> <maml:para>Adjusts the position of an object within its parent.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Set-ObjectPosition</maml:name> <!-- Parameter: Position --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>Position</maml:name> <maml:description> <maml:para>Position to move the object to. If this value is higher than the number of items in the parent object, this object will be moved to the position closest possible position.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: Object --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Object</maml:name> <maml:description> <maml:para>The object to move.</maml:para> </maml:description> <command:parameterValue required="true">SensorOrDeviceOrGroupOrProbe</command:parameterValue> <dev:type> <maml:name>PrtgAPI.Objects.Shared.SensorOrDeviceOrGroupOrProbe</maml:name> <maml:uri /> <maml:description> <maml:para>Properties that apply to Sensors, Devices, Groups and Probes.</maml:para> </maml:description> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Object --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Object</maml:name> <maml:description> <maml:para>The object to move.</maml:para> </maml:description> <command:parameterValue required="true">SensorOrDeviceOrGroupOrProbe</command:parameterValue> <dev:type> <maml:name>PrtgAPI.Objects.Shared.SensorOrDeviceOrGroupOrProbe</maml:name> <maml:uri /> <maml:description> <maml:para>Properties that apply to Sensors, Devices, Groups and Probes.</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: Position --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>Position</maml:name> <maml:description> <maml:para>Position to move the object to. If this value is higher than the number of items in the parent object, this object will be moved to the position closest possible position.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>PrtgAPI.Objects.Shared.SensorOrDeviceOrGroupOrProbe</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The object to move.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> </command:command> <!-- Cmdlet: Get-ObjectProperty --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-ObjectProperty</command:name> <command:verb>Get</command:verb> <command:noun>ObjectProperty</command:noun> <maml:description> <maml:para>Retrieves properties and settings of a PRTG Object.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Get-ObjectProperty cmdlet retrieves properties and settings of a PRTG Object, as found on the "Settings" tab within the PRTG UI. Properties retrieved by Get-ObjectProperty may not necessarily be active depending on the value of their dependent property (e.g. the Interval will not take effect if InheritInterval is $true).</maml:para> <maml:para>Properties that are not currently supported by Get-ObjectProperty can be retrieved by specifying the -RawProperty parameter. Raw property names can be found by inspecting the "name" attribute of the <input/> tag under the object's Settings page in the PRTG UI. Unlike Set-ObjectProperty, raw property names do not need to include their trailing underscores when used with Get-ObjectProperty. If a trailing underscore is used, PrtgAPI will automatically truncate it. When retrieving raw properties please note that PRTG does not support the retrieval of Inheritance related properties via raw lookups.</maml:para> <maml:para>In order to provide type safety when modifying properties, all properties supported by Set-ObjectProperty perform a lookup against their corresponding property in Get-ObjectProperty. If the type of value passed to Set-ObjectProperty does not match the property's expected type, PrtgAPI will attempt to parse the value into the expected type. For more information, see Set-ObjectProperty.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: Raw --> <command:syntaxItem> <maml:name>Get-ObjectProperty</maml:name> <!-- Parameter: Object --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Object</maml:name> <maml:description> <maml:para>The object to retrieve properties of.</maml:para> </maml:description> <command:parameterValue required="true">SensorOrDeviceOrGroupOrProbe</command:parameterValue> <dev:type> <maml:name>PrtgAPI.Objects.Shared.SensorOrDeviceOrGroupOrProbe</maml:name> <maml:uri /> <maml:description> <maml:para>Properties that apply to Sensors, Devices, Groups and Probes.</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: RawProperty --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>RawProperty</maml:name> <maml:description> <maml:para>The raw name of the property to retrieve. This can be typically discovered by inspecting the "name" attribute of the properties' <input/> tag on the Settings page of PRTG. Note: PRTG does not support retrieving raw section inheritance settings.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Object --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Object</maml:name> <maml:description> <maml:para>The object to retrieve properties of.</maml:para> </maml:description> <command:parameterValue required="true">SensorOrDeviceOrGroupOrProbe</command:parameterValue> <dev:type> <maml:name>PrtgAPI.Objects.Shared.SensorOrDeviceOrGroupOrProbe</maml:name> <maml:uri /> <maml:description> <maml:para>Properties that apply to Sensors, Devices, Groups and Probes.</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: RawProperty --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>RawProperty</maml:name> <maml:description> <maml:para>The raw name of the property to retrieve. This can be typically discovered by inspecting the "name" attribute of the properties' <input/> tag on the Settings page of PRTG. Note: PRTG does not support retrieving raw section inheritance settings.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>PrtgAPI.Objects.Shared.SensorOrDeviceOrGroupOrProbe</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The object to retrieve properties of.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>C:\> Get-Device -Id 1001 | Get-ObjectProperty</dev:code> <dev:remarks> <maml:para>Retrieve all properties and settings of the device with ID 1001</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>C:\> Get-Device -Id 1001 | Get-ObjectProperty -RawProperty name_</dev:code> <dev:remarks> <maml:para>Retrieve the value of raw property "name"</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Set-ObjectProperty</maml:linkText> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-Sensor</maml:linkText> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-Device</maml:linkText> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-Group</maml:linkText> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-Probe</maml:linkText> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Set-ObjectProperty --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Set-ObjectProperty</command:name> <command:verb>Set</command:verb> <command:noun>ObjectProperty</command:noun> <maml:description> <maml:para>Modifies the value of an object property.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Set-ObjectProperty cmdlet modifies properties and settings of PRTG Sensors, Devices, Groups and Probes. All supported properties that can be modified are typesafe, using the type of the property on the Settings object returned from Get-ObjectProperty.</maml:para> <maml:para>When a value is specified, Set-ObjectProperty will attempt to parse the value into its expected type. If the type cannot be parsed, an exception will be thrown indicating the type of the object specified and the type of value that was expected. In the case of enums, Set-ObjectProperty will list all valid values of the target type so that you may know how exactly to interface with the specified property.</maml:para> <maml:para>In the event a property is specified that has a dependency on another property being set (such as Interval requiring InheritInterval be $false, DBPort require DBPortMode be manual, etc) Set-ObjectProperty will automatically assign the required values such that the original property may be correctly enabled.</maml:para> <maml:para>For properties that are not currently supported by PrtgAPI, these settings can still be interfaced with via the -RawProperty and -RawValue parameters. When -Raw* parameters are specified, PrtgAPI will not perform any validation on the specified values. The -RawProperty parameter must contain the raw property name, as typically found on the "name" attribute of the <input/> tag under the object's Settings page in the PRTG UI. All properties that end in an underscore should include this in their names. All properties typically end in an underscore, with the exception of section inheritance properties (Inherit Windows Credentials, etc)</maml:para> <maml:para>For a list of settings currently supported by Set-ObjectProperty, see Get-Help about_ObjectSettings and about_SensorSettings.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: Default --> <command:syntaxItem> <maml:name>Set-ObjectProperty</maml:name> <!-- Parameter: Property --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>Property</maml:name> <maml:description> <maml:para>The property to modify.</maml:para> <maml:para>Possible values: Active, InheritWindowsCredentials, WindowsDomain, WindowsUserName, InheritLocation, Location, InheritLinuxCredentials, LinuxUserName, LinuxLoginMode, WbemProtocolMode, WbemPortMode, WbemPort, SSHPort, SSHElevationMode, SSHEngine, InheritVMwareCredentials, VMwareUserName, VMwareProtocol, VMwareSessionMode, InheritSNMPCredentials, SNMPVersion, SNMPCommunityStringV1, SNMPCommunityStringV2, SNMPv3AuthType, SNMPv3UserName, SNMPv3EncryptionType, SNMPv3Context, SNMPPort, SNMPTimeout, InheritDBCredentials, DBPortMode, DBPort, DBAuthMode, DBUserName, DBTimeout, InheritAmazonCredentials, AmazonAccessKey, InheritWindowsCompatibility, WmiDataSource, WmiTimeoutMethod, WmiTimeout, InheritSNMPCompatibility, SNMPDelay, SNMPRetryMode, SNMPOverflowMode, SNMPZeroValueMode, SNMPCounterMode, SNMPRequestMode, SNMPPortNameTemplate, SNMPPortNameUpdateMode, SNMPPortIdMode, SNMPInterfaceStartIndex, SNMPInterfaceEndIndex, InheritAccess, Name, Tags, Priority, DebugMode, Url, HttpRequestMethod, UseSNIFromUrl, Timeout, PingPacketSize, PingMode, PingCount, PingDelay, AutoAcknowledge, InheritInterval, Interval, IntervalErrorMode, GraphType, ExeParameters, SetExeEnvironmentVariables, UseWindowsAuthentication, Mutex, EnableChangeTriggers, WmiMode, Target, PingRemotePacketSize</maml:para> </maml:description> <command:parameterValue required="true">ObjectProperty</command:parameterValue> <dev:type> <maml:name>PrtgAPI.ObjectProperty</maml:name> <maml:uri /> <maml:description> <maml:para>Specifies the settings of objects that can be interfaced with using the PRTG HTTP API.</maml:para> </maml:description> </dev:type> <dev:defaultValue>Active</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Active</command:parameterValue> <command:parameterValue required="false" variableLength="false">InheritWindowsCredentials</command:parameterValue> <command:parameterValue required="false" variableLength="false">WindowsDomain</command:parameterValue> <command:parameterValue required="false" variableLength="false">WindowsUserName</command:parameterValue> <command:parameterValue required="false" variableLength="false">InheritLocation</command:parameterValue> <command:parameterValue required="false" variableLength="false">Location</command:parameterValue> <command:parameterValue required="false" variableLength="false">InheritLinuxCredentials</command:parameterValue> <command:parameterValue required="false" variableLength="false">LinuxUserName</command:parameterValue> <command:parameterValue required="false" variableLength="false">LinuxLoginMode</command:parameterValue> <command:parameterValue required="false" variableLength="false">WbemProtocolMode</command:parameterValue> <command:parameterValue required="false" variableLength="false">WbemPortMode</command:parameterValue> <command:parameterValue required="false" variableLength="false">WbemPort</command:parameterValue> <command:parameterValue required="false" variableLength="false">SSHPort</command:parameterValue> <command:parameterValue required="false" variableLength="false">SSHElevationMode</command:parameterValue> <command:parameterValue required="false" variableLength="false">SSHEngine</command:parameterValue> <command:parameterValue required="false" variableLength="false">InheritVMwareCredentials</command:parameterValue> <command:parameterValue required="false" variableLength="false">VMwareUserName</command:parameterValue> <command:parameterValue required="false" variableLength="false">VMwareProtocol</command:parameterValue> <command:parameterValue required="false" variableLength="false">VMwareSessionMode</command:parameterValue> <command:parameterValue required="false" variableLength="false">InheritSNMPCredentials</command:parameterValue> <command:parameterValue required="false" variableLength="false">SNMPVersion</command:parameterValue> <command:parameterValue required="false" variableLength="false">SNMPCommunityStringV1</command:parameterValue> <command:parameterValue required="false" variableLength="false">SNMPCommunityStringV2</command:parameterValue> <command:parameterValue required="false" variableLength="false">SNMPv3AuthType</command:parameterValue> <command:parameterValue required="false" variableLength="false">SNMPv3UserName</command:parameterValue> <command:parameterValue required="false" variableLength="false">SNMPv3EncryptionType</command:parameterValue> <command:parameterValue required="false" variableLength="false">SNMPv3Context</command:parameterValue> <command:parameterValue required="false" variableLength="false">SNMPPort</command:parameterValue> <command:parameterValue required="false" variableLength="false">SNMPTimeout</command:parameterValue> <command:parameterValue required="false" variableLength="false">InheritDBCredentials</command:parameterValue> <command:parameterValue required="false" variableLength="false">DBPortMode</command:parameterValue> <command:parameterValue required="false" variableLength="false">DBPort</command:parameterValue> <command:parameterValue required="false" variableLength="false">DBAuthMode</command:parameterValue> <command:parameterValue required="false" variableLength="false">DBUserName</command:parameterValue> <command:parameterValue required="false" variableLength="false">DBTimeout</command:parameterValue> <command:parameterValue required="false" variableLength="false">InheritAmazonCredentials</command:parameterValue> <command:parameterValue required="false" variableLength="false">AmazonAccessKey</command:parameterValue> <command:parameterValue required="false" variableLength="false">InheritWindowsCompatibility</command:parameterValue> <command:parameterValue required="false" variableLength="false">WmiDataSource</command:parameterValue> <command:parameterValue required="false" variableLength="false">WmiTimeoutMethod</command:parameterValue> <command:parameterValue required="false" variableLength="false">WmiTimeout</command:parameterValue> <command:parameterValue required="false" variableLength="false">InheritSNMPCompatibility</command:parameterValue> <command:parameterValue required="false" variableLength="false">SNMPDelay</command:parameterValue> <command:parameterValue required="false" variableLength="false">SNMPRetryMode</command:parameterValue> <command:parameterValue required="false" variableLength="false">SNMPOverflowMode</command:parameterValue> <command:parameterValue required="false" variableLength="false">SNMPZeroValueMode</command:parameterValue> <command:parameterValue required="false" variableLength="false">SNMPCounterMode</command:parameterValue> <command:parameterValue required="false" variableLength="false">SNMPRequestMode</command:parameterValue> <command:parameterValue required="false" variableLength="false">SNMPPortNameTemplate</command:parameterValue> <command:parameterValue required="false" variableLength="false">SNMPPortNameUpdateMode</command:parameterValue> <command:parameterValue required="false" variableLength="false">SNMPPortIdMode</command:parameterValue> <command:parameterValue required="false" variableLength="false">SNMPInterfaceStartIndex</command:parameterValue> <command:parameterValue required="false" variableLength="false">SNMPInterfaceEndIndex</command:parameterValue> <command:parameterValue required="false" variableLength="false">InheritAccess</command:parameterValue> <command:parameterValue required="false" variableLength="false">Name</command:parameterValue> <command:parameterValue required="false" variableLength="false">Tags</command:parameterValue> <command:parameterValue required="false" variableLength="false">Priority</command:parameterValue> <command:parameterValue required="false" variableLength="false">DebugMode</command:parameterValue> <command:parameterValue required="false" variableLength="false">Url</command:parameterValue> <command:parameterValue required="false" variableLength="false">HttpRequestMethod</command:parameterValue> <command:parameterValue required="false" variableLength="false">UseSNIFromUrl</command:parameterValue> <command:parameterValue required="false" variableLength="false">Timeout</command:parameterValue> <command:parameterValue required="false" variableLength="false">PingPacketSize</command:parameterValue> <command:parameterValue required="false" variableLength="false">PingMode</command:parameterValue> <command:parameterValue required="false" variableLength="false">PingCount</command:parameterValue> <command:parameterValue required="false" variableLength="false">PingDelay</command:parameterValue> <command:parameterValue required="false" variableLength="false">AutoAcknowledge</command:parameterValue> <command:parameterValue required="false" variableLength="false">InheritInterval</command:parameterValue> <command:parameterValue required="false" variableLength="false">Interval</command:parameterValue> <command:parameterValue required="false" variableLength="false">IntervalErrorMode</command:parameterValue> <command:parameterValue required="false" variableLength="false">GraphType</command:parameterValue> <command:parameterValue required="false" variableLength="false">ExeParameters</command:parameterValue> <command:parameterValue required="false" variableLength="false">SetExeEnvironmentVariables</command:parameterValue> <command:parameterValue required="false" variableLength="false">UseWindowsAuthentication</command:parameterValue> <command:parameterValue required="false" variableLength="false">Mutex</command:parameterValue> <command:parameterValue required="false" variableLength="false">EnableChangeTriggers</command:parameterValue> <command:parameterValue required="false" variableLength="false">WmiMode</command:parameterValue> <command:parameterValue required="false" variableLength="false">Target</command:parameterValue> <command:parameterValue required="false" variableLength="false">PingRemotePacketSize</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: Value --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Value</maml:name> <maml:description> <maml:para>The value to set for the specified property.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Object --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Object</maml:name> <maml:description> <maml:para>The object to modify the properties of.</maml:para> </maml:description> <command:parameterValue required="true">SensorOrDeviceOrGroupOrProbe</command:parameterValue> <dev:type> <maml:name>PrtgAPI.Objects.Shared.SensorOrDeviceOrGroupOrProbe</maml:name> <maml:uri /> <maml:description> <maml:para>Properties that apply to Sensors, Devices, Groups and Probes.</maml:para> </maml:description> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: Unsafe --> <command:syntaxItem> <maml:name>Set-ObjectProperty</maml:name> <!-- Parameter: Object --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Object</maml:name> <maml:description> <maml:para>The object to modify the properties of.</maml:para> </maml:description> <command:parameterValue required="true">SensorOrDeviceOrGroupOrProbe</command:parameterValue> <dev:type> <maml:name>PrtgAPI.Objects.Shared.SensorOrDeviceOrGroupOrProbe</maml:name> <maml:uri /> <maml:description> <maml:para>Properties that apply to Sensors, Devices, Groups and Probes.</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: RawProperty --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>RawProperty</maml:name> <maml:description> <maml:para>The raw name of the property to modify. This can be typically discovered by inspecting the "name" attribute of the properties' <input/> tag on the Settings page of PRTG.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: RawValue --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>RawValue</maml:name> <maml:description> <maml:para>The value to set the object's property to. For radio buttons and dropdown lists, this is the integer found in the 'value' attribute. WARNING: If an invalid value is set for a property, minor corruption may occur.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Force --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Sets an unsafe object property without prompting for confirmation. WARNING: Setting an invalid value for a property can cause minor corruption. Only use if you know what you are doing.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Object --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Object</maml:name> <maml:description> <maml:para>The object to modify the properties of.</maml:para> </maml:description> <command:parameterValue required="true">SensorOrDeviceOrGroupOrProbe</command:parameterValue> <dev:type> <maml:name>PrtgAPI.Objects.Shared.SensorOrDeviceOrGroupOrProbe</maml:name> <maml:uri /> <maml:description> <maml:para>Properties that apply to Sensors, Devices, Groups and Probes.</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: Property --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>Property</maml:name> <maml:description> <maml:para>The property to modify.</maml:para> <maml:para>Possible values: Active, InheritWindowsCredentials, WindowsDomain, WindowsUserName, InheritLocation, Location, InheritLinuxCredentials, LinuxUserName, LinuxLoginMode, WbemProtocolMode, WbemPortMode, WbemPort, SSHPort, SSHElevationMode, SSHEngine, InheritVMwareCredentials, VMwareUserName, VMwareProtocol, VMwareSessionMode, InheritSNMPCredentials, SNMPVersion, SNMPCommunityStringV1, SNMPCommunityStringV2, SNMPv3AuthType, SNMPv3UserName, SNMPv3EncryptionType, SNMPv3Context, SNMPPort, SNMPTimeout, InheritDBCredentials, DBPortMode, DBPort, DBAuthMode, DBUserName, DBTimeout, InheritAmazonCredentials, AmazonAccessKey, InheritWindowsCompatibility, WmiDataSource, WmiTimeoutMethod, WmiTimeout, InheritSNMPCompatibility, SNMPDelay, SNMPRetryMode, SNMPOverflowMode, SNMPZeroValueMode, SNMPCounterMode, SNMPRequestMode, SNMPPortNameTemplate, SNMPPortNameUpdateMode, SNMPPortIdMode, SNMPInterfaceStartIndex, SNMPInterfaceEndIndex, InheritAccess, Name, Tags, Priority, DebugMode, Url, HttpRequestMethod, UseSNIFromUrl, Timeout, PingPacketSize, PingMode, PingCount, PingDelay, AutoAcknowledge, InheritInterval, Interval, IntervalErrorMode, GraphType, ExeParameters, SetExeEnvironmentVariables, UseWindowsAuthentication, Mutex, EnableChangeTriggers, WmiMode, Target, PingRemotePacketSize</maml:para> </maml:description> <command:parameterValue required="true">ObjectProperty</command:parameterValue> <dev:type> <maml:name>PrtgAPI.ObjectProperty</maml:name> <maml:uri /> <maml:description> <maml:para>Specifies the settings of objects that can be interfaced with using the PRTG HTTP API.</maml:para> </maml:description> </dev:type> <dev:defaultValue>Active</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Active</command:parameterValue> <command:parameterValue required="false" variableLength="false">InheritWindowsCredentials</command:parameterValue> <command:parameterValue required="false" variableLength="false">WindowsDomain</command:parameterValue> <command:parameterValue required="false" variableLength="false">WindowsUserName</command:parameterValue> <command:parameterValue required="false" variableLength="false">InheritLocation</command:parameterValue> <command:parameterValue required="false" variableLength="false">Location</command:parameterValue> <command:parameterValue required="false" variableLength="false">InheritLinuxCredentials</command:parameterValue> <command:parameterValue required="false" variableLength="false">LinuxUserName</command:parameterValue> <command:parameterValue required="false" variableLength="false">LinuxLoginMode</command:parameterValue> <command:parameterValue required="false" variableLength="false">WbemProtocolMode</command:parameterValue> <command:parameterValue required="false" variableLength="false">WbemPortMode</command:parameterValue> <command:parameterValue required="false" variableLength="false">WbemPort</command:parameterValue> <command:parameterValue required="false" variableLength="false">SSHPort</command:parameterValue> <command:parameterValue required="false" variableLength="false">SSHElevationMode</command:parameterValue> <command:parameterValue required="false" variableLength="false">SSHEngine</command:parameterValue> <command:parameterValue required="false" variableLength="false">InheritVMwareCredentials</command:parameterValue> <command:parameterValue required="false" variableLength="false">VMwareUserName</command:parameterValue> <command:parameterValue required="false" variableLength="false">VMwareProtocol</command:parameterValue> <command:parameterValue required="false" variableLength="false">VMwareSessionMode</command:parameterValue> <command:parameterValue required="false" variableLength="false">InheritSNMPCredentials</command:parameterValue> <command:parameterValue required="false" variableLength="false">SNMPVersion</command:parameterValue> <command:parameterValue required="false" variableLength="false">SNMPCommunityStringV1</command:parameterValue> <command:parameterValue required="false" variableLength="false">SNMPCommunityStringV2</command:parameterValue> <command:parameterValue required="false" variableLength="false">SNMPv3AuthType</command:parameterValue> <command:parameterValue required="false" variableLength="false">SNMPv3UserName</command:parameterValue> <command:parameterValue required="false" variableLength="false">SNMPv3EncryptionType</command:parameterValue> <command:parameterValue required="false" variableLength="false">SNMPv3Context</command:parameterValue> <command:parameterValue required="false" variableLength="false">SNMPPort</command:parameterValue> <command:parameterValue required="false" variableLength="false">SNMPTimeout</command:parameterValue> <command:parameterValue required="false" variableLength="false">InheritDBCredentials</command:parameterValue> <command:parameterValue required="false" variableLength="false">DBPortMode</command:parameterValue> <command:parameterValue required="false" variableLength="false">DBPort</command:parameterValue> <command:parameterValue required="false" variableLength="false">DBAuthMode</command:parameterValue> <command:parameterValue required="false" variableLength="false">DBUserName</command:parameterValue> <command:parameterValue required="false" variableLength="false">DBTimeout</command:parameterValue> <command:parameterValue required="false" variableLength="false">InheritAmazonCredentials</command:parameterValue> <command:parameterValue required="false" variableLength="false">AmazonAccessKey</command:parameterValue> <command:parameterValue required="false" variableLength="false">InheritWindowsCompatibility</command:parameterValue> <command:parameterValue required="false" variableLength="false">WmiDataSource</command:parameterValue> <command:parameterValue required="false" variableLength="false">WmiTimeoutMethod</command:parameterValue> <command:parameterValue required="false" variableLength="false">WmiTimeout</command:parameterValue> <command:parameterValue required="false" variableLength="false">InheritSNMPCompatibility</command:parameterValue> <command:parameterValue required="false" variableLength="false">SNMPDelay</command:parameterValue> <command:parameterValue required="false" variableLength="false">SNMPRetryMode</command:parameterValue> <command:parameterValue required="false" variableLength="false">SNMPOverflowMode</command:parameterValue> <command:parameterValue required="false" variableLength="false">SNMPZeroValueMode</command:parameterValue> <command:parameterValue required="false" variableLength="false">SNMPCounterMode</command:parameterValue> <command:parameterValue required="false" variableLength="false">SNMPRequestMode</command:parameterValue> <command:parameterValue required="false" variableLength="false">SNMPPortNameTemplate</command:parameterValue> <command:parameterValue required="false" variableLength="false">SNMPPortNameUpdateMode</command:parameterValue> <command:parameterValue required="false" variableLength="false">SNMPPortIdMode</command:parameterValue> <command:parameterValue required="false" variableLength="false">SNMPInterfaceStartIndex</command:parameterValue> <command:parameterValue required="false" variableLength="false">SNMPInterfaceEndIndex</command:parameterValue> <command:parameterValue required="false" variableLength="false">InheritAccess</command:parameterValue> <command:parameterValue required="false" variableLength="false">Name</command:parameterValue> <command:parameterValue required="false" variableLength="false">Tags</command:parameterValue> <command:parameterValue required="false" variableLength="false">Priority</command:parameterValue> <command:parameterValue required="false" variableLength="false">DebugMode</command:parameterValue> <command:parameterValue required="false" variableLength="false">Url</command:parameterValue> <command:parameterValue required="false" variableLength="false">HttpRequestMethod</command:parameterValue> <command:parameterValue required="false" variableLength="false">UseSNIFromUrl</command:parameterValue> <command:parameterValue required="false" variableLength="false">Timeout</command:parameterValue> <command:parameterValue required="false" variableLength="false">PingPacketSize</command:parameterValue> <command:parameterValue required="false" variableLength="false">PingMode</command:parameterValue> <command:parameterValue required="false" variableLength="false">PingCount</command:parameterValue> <command:parameterValue required="false" variableLength="false">PingDelay</command:parameterValue> <command:parameterValue required="false" variableLength="false">AutoAcknowledge</command:parameterValue> <command:parameterValue required="false" variableLength="false">InheritInterval</command:parameterValue> <command:parameterValue required="false" variableLength="false">Interval</command:parameterValue> <command:parameterValue required="false" variableLength="false">IntervalErrorMode</command:parameterValue> <command:parameterValue required="false" variableLength="false">GraphType</command:parameterValue> <command:parameterValue required="false" variableLength="false">ExeParameters</command:parameterValue> <command:parameterValue required="false" variableLength="false">SetExeEnvironmentVariables</command:parameterValue> <command:parameterValue required="false" variableLength="false">UseWindowsAuthentication</command:parameterValue> <command:parameterValue required="false" variableLength="false">Mutex</command:parameterValue> <command:parameterValue required="false" variableLength="false">EnableChangeTriggers</command:parameterValue> <command:parameterValue required="false" variableLength="false">WmiMode</command:parameterValue> <command:parameterValue required="false" variableLength="false">Target</command:parameterValue> <command:parameterValue required="false" variableLength="false">PingRemotePacketSize</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: Value --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Value</maml:name> <maml:description> <maml:para>The value to set for the specified property.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: RawProperty --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>RawProperty</maml:name> <maml:description> <maml:para>The raw name of the property to modify. This can be typically discovered by inspecting the "name" attribute of the properties' <input/> tag on the Settings page of PRTG.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: RawValue --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>RawValue</maml:name> <maml:description> <maml:para>The value to set the object's property to. For radio buttons and dropdown lists, this is the integer found in the 'value' attribute. WARNING: If an invalid value is set for a property, minor corruption may occur.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Force --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Sets an unsafe object property without prompting for confirmation. WARNING: Setting an invalid value for a property can cause minor corruption. Only use if you know what you are doing.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>PrtgAPI.Objects.Shared.SensorOrDeviceOrGroupOrProbe</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The object to modify the properties of.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>C:\> Get-Sensor -Id 1001 | Set-ObjectProperty Interval "00:00:30"</dev:code> <dev:remarks> <maml:para>C:\> Get-Sensor -Id 1001 | Set-ObjectProperty Interval ([TimeSpan]"00:00:30")</maml:para> <maml:para>C:\> Get-Sensor -Id 1001 | Set-ObjectProperty Interval ThirtySeconds</maml:para> <maml:para>Set the Scanning Interval of the sensor with ID 1001 to 30 seconds. Type "ScanningInterval" expected by property Interval will attempt to coerce strings, TimeSpans and enums into a ScanningInterval object. If the cmdlet succeeds, InheritInterval will also be set to false.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>C:\> Get-Sensor -Id | 1001 | Set-ObjectProperty -RawProperty name_ -RawValue newName</dev:code> <dev:remarks> <maml:para>Set raw property "name" to value "newName"</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>about_ObjectSettings</maml:linkText> </maml:navigationLink> <maml:navigationLink> <maml:linkText>about_SensorSettings</maml:linkText> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-ObjectProperty</maml:linkText> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-Sensor</maml:linkText> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-Device</maml:linkText> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-Probe</maml:linkText> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Get-Probe --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-Probe</command:name> <command:verb>Get</command:verb> <command:noun>Probe</command:noun> <maml:description> <maml:para>Retrieves probes from a PRTG Server.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Get-Probe cmdlet retrieves probes from a PRTG Server. Probes represent sites where the PRTG Probe Service has been installed. Each PRTG Server has a single Core Probe. Additional probes may be installed with the PRTG Remote Probe installer for monitoring of remote sites. Get-Probe provides a variety of methods of filtering the probes requested from PRTG, including by probe name, ID and tags. Multiple filters can be used in conjunction to further limit the number of results returned.</maml:para> <maml:para>For scenarios in which you wish to filter on properties not covered by the parameters available in Get-Probe, a custom SearchFilter object can be created by specifying the field name, condition and value to filter upon. For information on properties that can be filtered upon, see New-SearchFilter</maml:para> <maml:para>The Probe objects returned from Get-Probe can be piped to a variety of other cmdlets for further processing, including Get-Group, Get-Device and Get-Sensor, where the ID or name of the probe will be used to filter for child objects of the specified type.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Get-Probe</maml:name> <!-- Parameter: Name --> <command:parameter required="false" globbing="false" pipelineInput="false" position="0"> <maml:name>Name</maml:name> <maml:description> <maml:para>Filter the response to objects with a certain name. Can include wildcards.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Filter --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="1"> <maml:name>Filter</maml:name> <maml:description> <maml:para>Filter the response to objects that match one or more criteria.</maml:para> </maml:description> <command:parameterValue required="true">SearchFilter[]</command:parameterValue> <dev:type> <maml:name>PrtgAPI.SearchFilter[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Count --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Count</maml:name> <maml:description> <maml:para>Maximum number of results to return.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Id --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Id</maml:name> <maml:description> <maml:para>Retrieve an object with a specified ID.</maml:para> </maml:description> <command:parameterValue required="true">Nullable`1[]</command:parameterValue> <dev:type> <maml:name>System.Nullable`1[[System.Int32, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]][]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Status --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Status</maml:name> <maml:description> <maml:para>Only retrieve objects that match a specific status.</maml:para> </maml:description> <command:parameterValue required="true">Status[]</command:parameterValue> <dev:type> <maml:name>PrtgAPI.Status[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Tags --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Tags</maml:name> <maml:description> <maml:para>Filter the response to objects with certain tags. Can include wildcards.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Name --> <command:parameter required="false" globbing="false" pipelineInput="false" position="0"> <maml:name>Name</maml:name> <maml:description> <maml:para>Filter the response to objects with a certain name. Can include wildcards.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Id --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Id</maml:name> <maml:description> <maml:para>Retrieve an object with a specified ID.</maml:para> </maml:description> <command:parameterValue required="true">Nullable`1[]</command:parameterValue> <dev:type> <maml:name>System.Nullable`1[[System.Int32, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]][]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Filter --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="1"> <maml:name>Filter</maml:name> <maml:description> <maml:para>Filter the response to objects that match one or more criteria.</maml:para> </maml:description> <command:parameterValue required="true">SearchFilter[]</command:parameterValue> <dev:type> <maml:name>PrtgAPI.SearchFilter[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Tags --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Tags</maml:name> <maml:description> <maml:para>Filter the response to objects with certain tags. Can include wildcards.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Status --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Status</maml:name> <maml:description> <maml:para>Only retrieve objects that match a specific status.</maml:para> </maml:description> <command:parameterValue required="true">Status[]</command:parameterValue> <dev:type> <maml:name>PrtgAPI.Status[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Count --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Count</maml:name> <maml:description> <maml:para>Maximum number of results to return.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>PrtgAPI.SearchFilter[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Filter the response to objects that match one or more criteria.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>PrtgAPI.Status[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Only retrieve objects that match a specific status.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: Probe --> <command:returnValue> <dev:type> <maml:name>PrtgAPI.Probe</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>A device used to perform monitoring against a site or set of systems.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>C:\> Get-Probe contoso</dev:code> <dev:remarks> <maml:para>Get all probes named "contoso" (case insensitive)</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>C:\> Get-Probe *office*</dev:code> <dev:remarks> <maml:para>Get all probes whose name contains "office" (case insensitive)</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 3 ----------</maml:title> <dev:code>C:\> Get-Probe -Id 1</dev:code> <dev:remarks> <maml:para>Get the probe with ID 1</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 4 ----------</maml:title> <dev:code>C:\> Get-Probe -Count 1</dev:code> <dev:remarks> <maml:para>Get only 1 probe from PRTG.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 5 ----------</maml:title> <dev:code>C:\> New-SearchFilter totalsens greaterthan 100 | Get-Probe</dev:code> <dev:remarks> <maml:para>Get all probes that contain more than 100 sensors.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Get-Sensor</maml:linkText> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-Device</maml:linkText> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-Group</maml:linkText> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-SearchFilter</maml:linkText> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Get-PrtgClient --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-PrtgClient</command:name> <command:verb>Get</command:verb> <command:noun>PrtgClient</command:noun> <maml:description> <maml:para>Retrieves the current session's PrtgClient</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Get-PrtgClient cmdlet allows you to access the PrtgClient of the current session previously created with a call to Connect-PrtgServer. This allows you to view/edit the properties of the PrtgClient previously defined in your call to Connect-PrtgServer, as well as access the raw C# PrtgAPI should you wish to bypass or access methods not in the PowerShell interface.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Get-PrtgClient</maml:name> </command:syntaxItem> </command:syntax> <command:parameters /> <command:inputTypes /> <command:returnValues> <!-- OutputType: PrtgClient --> <command:returnValue> <dev:type> <maml:name>PrtgAPI.PrtgClient</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Provides methods for generating API requests against a PRTG Network Monitor server.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>C:\> Get-PrtgClient</dev:code> <dev:remarks> <maml:para>View the settings of the session's PrtgClient. If the session does not have a PrtgClient, the cmdlet returns null</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>C:\> (Get-PrtgClient).RetryCount = 5</dev:code> <dev:remarks> <maml:para>Change the RetryCount of the PrtgClient to 5</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 3 ----------</maml:title> <dev:code>C:\> (Get-PrtgClient).GetSensors()</dev:code> <dev:remarks> <maml:para>Invoke the GetSensors method of the PrtgClient</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Connect-PrtgServer</maml:linkText> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Disconnect-PrtgServer</maml:linkText> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Open-PrtgObject --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Open-PrtgObject</command:name> <command:verb>Open</command:verb> <command:noun>PrtgObject</command:noun> <maml:description> <maml:para>Opens the URL of a PRTG Object in the PRTG Web Interface.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Open-PrtgObject cmdlet opens the web page of a PRTG Object in your default browser. Care should be taken with Open-PrtgObject, as your system may experience performance issues if too many URLs are opened at one time.</maml:para> <maml:para>Open-PrtgObject is only compatible with objects that contain a URL field; namely Probes, Devices, Groups and Sensors.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Open-PrtgObject</maml:name> <!-- Parameter: Object --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Object</maml:name> <maml:description> <maml:para>The object to open.</maml:para> </maml:description> <command:parameterValue required="true">SensorOrDeviceOrGroupOrProbe</command:parameterValue> <dev:type> <maml:name>PrtgAPI.Objects.Shared.SensorOrDeviceOrGroupOrProbe</maml:name> <maml:uri /> <maml:description> <maml:para>Properties that apply to Sensors, Devices, Groups and Probes.</maml:para> </maml:description> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Object --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Object</maml:name> <maml:description> <maml:para>The object to open.</maml:para> </maml:description> <command:parameterValue required="true">SensorOrDeviceOrGroupOrProbe</command:parameterValue> <dev:type> <maml:name>PrtgAPI.Objects.Shared.SensorOrDeviceOrGroupOrProbe</maml:name> <maml:uri /> <maml:description> <maml:para>Properties that apply to Sensors, Devices, Groups and Probes.</maml:para> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>PrtgAPI.Objects.Shared.SensorOrDeviceOrGroupOrProbe</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The object to open.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>C:\> Get-Device dc-1 | Get-Sensor ping | Open-PrtgObject</dev:code> <dev:remarks> <maml:para>Open all sensors named "ping" under devices named "dc-1" in the default web browser.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Get-Sensor</maml:linkText> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-Device</maml:linkText> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-Group</maml:linkText> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-Probe</maml:linkText> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Disable-PrtgProgress --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Disable-PrtgProgress</command:name> <command:verb>Disable</command:verb> <command:noun>PrtgProgress</command:noun> <maml:description> <maml:para>Disables PRTG Progress for the current PowerShell Session.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Disable-PrtgProgress disables displaying progress when piping between PrtgAPI cmdlets. By default, progress is enabled when PrtgAPI is used outside of scripts or the PowerShell ISE. Progress can then be manually controlled via the Enable-PrtgProgress and Disable-PrtgProgress cmdlets. If progress is manually disabled, this setting will only persist for the current PowerShell session, or until the next time Connect-PrtgServer is run.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Disable-PrtgProgress</maml:name> </command:syntaxItem> </command:syntax> <command:parameters /> <command:inputTypes /> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>C:\> Disable-PrtgProgress</dev:code> <dev:remarks> <maml:para>Disable PrtgAPI progress for the current session</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Enable-PrtgProgress</maml:linkText> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Connect-PrtgServer</maml:linkText> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Enable-PrtgProgress --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Enable-PrtgProgress</command:name> <command:verb>Enable</command:verb> <command:noun>PrtgProgress</command:noun> <maml:description> <maml:para>Enables PRTG Progress for the current PowerShell Session.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Enable-PrtgProgress enables displaying progress when piping between PrtgAPI cmdlets. By default, progress is enabled when PrtgAPI is used outside of scripts or the PowerShell ISE. Progress can then be manually controlled via the Enable-PrtgProgress and Disable-PrtgProgress cmdlets. If progress is manually enabled, this setting will only persist for the current PowerShell session, or until the next time Connect-PrtgServer is run.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Enable-PrtgProgress</maml:name> </command:syntaxItem> </command:syntax> <command:parameters /> <command:inputTypes /> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>C:\> Enable-PrtgProgress</dev:code> <dev:remarks> <maml:para>Enable PrtgAPI progress for the current session</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Disable-PrtgProgress</maml:linkText> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Connect-PrtgServer</maml:linkText> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Connect-PrtgServer --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Connect-PrtgServer</command:name> <command:verb>Connect</command:verb> <command:noun>PrtgServer</command:noun> <maml:description> <maml:para>Initializes a new instance of a PrtgClient. This cmdlet must be called at least once before attempting to use any other cmdlets.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Connect-PrtgServer cmdlet establishes a new connection to a PRTG Server. As PRTG uses a stateless REST API, Connect-PrtgServer initializes a PrtgClient which stores the settings that will be used when generating each request.</maml:para> <maml:para>PRTG supports two authentication methods: username/password and username/passhash. A PassHash is a numeric password generated by PRTG that can be used in place of your regular password. When your PrtgClient is initialized, if you have specified a password PrtgAPI will automatically retrieve your account's PassHash for use in all future requests.</maml:para> <maml:para>By default when PRTG times out while processing a request PrtgAPI will throw an exception. This can be quite problematic when attempting to batch process a large number of items with PrtgAPI in PowerShell. You can request PrtgAPI automatically attempt to retry failed requests by specifying the -RetryCount and -RetryDelay parameters. If -RetryCount is greater than 0, PrtgAPI will send a warning to the pipeline indicating a failure has occurred, as well as the number of retries remaining before PrtgAPI gives up. Each request invocation uses a separate retry count.</maml:para> <maml:para>When Connect-PrtgServer is run from outside of a script or the PowerShell ISE, PrtgAPI will display PowerShell progress when piping between PrtgAPI cmdlets or when piping from variables containing PrtgAPI objects. This default setting can be overridden by specifying a value to the -Progress parameter, or by using the Enable-PrtgProgress and Disable-PrtgProgress cmdlets.</maml:para> <maml:para>Attempting to invoke Connect-PrtgServer after a PrtgClient has already been initialized for the current session will generate an exception. To override the existing PrtgClient, specify the -Force parameter to Connect-PrtgServer, or invalidate the PrtgClient by calling Disconnect-PrtgServer.</maml:para> <maml:para>For information on viewing and editing the session's PrtgClient settings see Get-PrtgClient.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Connect-PrtgServer</maml:name> <!-- Parameter: Server --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>Server</maml:name> <maml:description> <maml:para>Specifies the PRTG Server requests will be made against.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Credential --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="1"> <maml:name>Credential</maml:name> <maml:description> <maml:para>Specifies the username and password to authenticate with. If PassHash is specified, the password will be treated as a PassHash instead.</maml:para> </maml:description> <command:parameterValue required="true">PSCredential</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.PSCredential</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Force --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Forces a PrtgClient to be replaced if one already exists.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: PassHash --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PassHash</maml:name> <maml:description> <maml:para>Specifies that the Credential's password contains a PassHash instead of a Password.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Progress --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Progress</maml:name> <maml:description> <maml:para>Enable or disable PowerShell Progress when piping between cmdlets. By default, if Connect-PrtgServer is being called from within a script or the PowerShell ISE this value is false. Otherwise, true.</maml:para> </maml:description> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: RetryCount --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>RetryCount</maml:name> <maml:description> <maml:para>The number of times to retry a request that times out while communicating with PRTG.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>1</dev:defaultValue> </command:parameter> <!-- Parameter: RetryDelay --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>RetryDelay</maml:name> <maml:description> <maml:para>The base delay (in seconds) between retrying a timed out request. Each successive failure of a given request will wait an additional multiple of this value.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>3</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Server --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>Server</maml:name> <maml:description> <maml:para>Specifies the PRTG Server requests will be made against.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Credential --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="1"> <maml:name>Credential</maml:name> <maml:description> <maml:para>Specifies the username and password to authenticate with. If PassHash is specified, the password will be treated as a PassHash instead.</maml:para> </maml:description> <command:parameterValue required="true">PSCredential</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.PSCredential</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Force --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Forces a PrtgClient to be replaced if one already exists.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: PassHash --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PassHash</maml:name> <maml:description> <maml:para>Specifies that the Credential's password contains a PassHash instead of a Password.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: RetryCount --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>RetryCount</maml:name> <maml:description> <maml:para>The number of times to retry a request that times out while communicating with PRTG.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>1</dev:defaultValue> </command:parameter> <!-- Parameter: RetryDelay --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>RetryDelay</maml:name> <maml:description> <maml:para>The base delay (in seconds) between retrying a timed out request. Each successive failure of a given request will wait an additional multiple of this value.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>3</dev:defaultValue> </command:parameter> <!-- Parameter: Progress --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Progress</maml:name> <maml:description> <maml:para>Enable or disable PowerShell Progress when piping between cmdlets. By default, if Connect-PrtgServer is being called from within a script or the PowerShell ISE this value is false. Otherwise, true.</maml:para> </maml:description> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Management.Automation.PSCredential</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Specifies the username and password to authenticate with. If PassHash is specified, the password will be treated as a PassHash instead.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>C:\> Connect-PrtgServer prtg.example.com</dev:code> <dev:remarks> <maml:para>Connect to a PRTG Server. You will receive a login prompt requesting you enter your credentials.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>C:\> Connect-PrtgServer prtg.example.com (New-Credential prtgadmin prtgadmin)</dev:code> <dev:remarks> <maml:para>Connect to a PRTG Server specifying your credentials as part of the command. The New-Credential cmdlet can be used when developing scripts to avoid a login prompt.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 3 ----------</maml:title> <dev:code>C:\> Connect-PrtgServer prtg.example2.com -Force</dev:code> <dev:remarks> <maml:para>Connect to a PRTG Server, overriding the session's existing PrtgClient (if applicable)</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 4 ----------</maml:title> <dev:code>C:\> Connect-PrtgServer http://prtg.example.com</dev:code> <dev:remarks> <maml:para>Connect to a PRTG Server using HTTP. http:// must be specified for servers that do not accept HTTPS.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 5 ----------</maml:title> <dev:code>C:\> Connect-PrtgServer prtg.example.com -RetryCount 3 -RetryDelay 5</dev:code> <dev:remarks> <maml:para>Connect to a PRTG Server, indicating that any requests that fail during the use of the PrtgClient should be attempted at most 3 times, with a delay of 5 seconds between each attempt.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Get-PrtgClient</maml:linkText> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Disconnect-PrtgServer</maml:linkText> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Enable-PrtgProgress</maml:linkText> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Disable-PrtgProgress</maml:linkText> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Disconnect-PrtgServer --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Disconnect-PrtgServer</command:name> <command:verb>Disconnect</command:verb> <command:noun>PrtgServer</command:noun> <maml:description> <maml:para>Invalidates a PrtgClient previously created with Connect-PrtgServer.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Disconnect-PrtgServer cmdlet invalidates a PrtgClient previously created with Connect-PrtgServer. As PRTG uses a stateless REST API, it is not necessary to call Disconnect-PrtgServer when you have finished making requests unless you are developing a script, in which case Connect-PrtgServer will fail to create a PrtgClient if a PRTG connection is already active in the current session. This can be circumvented by specifying the -Force parameter when establishing the connection. For more information, see Connect-PrtgServer.</maml:para> <maml:para>If Disconnect-PrtgServer is called when you are not connected to a PRTG Server, this cmdlet does nothing.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Disconnect-PrtgServer</maml:name> </command:syntaxItem> </command:syntax> <command:parameters /> <command:inputTypes /> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>C:\> Disconnect-PrtgServer</dev:code> <dev:remarks> <maml:para>Disconnect from the current PRTG Server</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Connect-PrtgServer</maml:linkText> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-PrtgClient</maml:linkText> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: New-SearchFilter --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>New-SearchFilter</command:name> <command:verb>New</command:verb> <command:noun>SearchFilter</command:noun> <maml:description> <maml:para>Filters results on the PRTG Server to improve performance.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The New-SearchFilter cmdlet allows you to filter the results returned by a cmdlet by a custom property. Each object returned from New-SearchFilter defines a single filter rule. Multiple filters can often be passed to compatible cmdlets to filter on multiple values.</maml:para> <maml:para>To view all properties that can be filtered on for on objects, see the SYNTAX or PARAMETERS section of this cmdlet's help page.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>New-SearchFilter</maml:name> <!-- Parameter: Property --> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>Property</maml:name> <maml:description> <maml:para>Object property to filter on.</maml:para> <maml:para>Possible values: Id, Type, Name, Tags, Active, Downtime, TotalDowntime, DownDuration, Uptime, TotalUptime, UpDuration, TotalMonitorTime, DataCollectedSince, Sensor, Interval, LastCheck, LastUp, LastDown, Device, Group, Probe, GrpDev, NotificationTypes, IntervalInherited, Access, Dependency, Status, Message, Priority, LastValue, UpSensors, DownSensors, DownAcknowledgedSensors, PartialDownSensors, WarningSensors, PausedSensors, UnusualSensors, UndefinedSensors, TotalSensors, Value, Coverage, Favorite, UserName, Parent, DateTime, DateOnly, TimeOnly, Schedule, Period, Email, Template, LastRun, NextRun, Size, MiniGraph, DeviceIcon, Comments, Host, Condition, BaseType, Url, Icon, ParentId, Location, Collapsed, TotalGroups, TotalDevices, TicketType, ModifiedBy, Actions, Content, Position</maml:para> </maml:description> <command:parameterValue required="true">Property</command:parameterValue> <dev:type> <maml:name>PrtgAPI.Property</maml:name> <maml:uri /> <maml:description> <maml:para>Specifies properties (referred to by PRTG as "columns") that can be retrieved for a PRTG Object.</maml:para> </maml:description> </dev:type> <dev:defaultValue>Id</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Id</command:parameterValue> <command:parameterValue required="false" variableLength="false">Type</command:parameterValue> <command:parameterValue required="false" variableLength="false">Name</command:parameterValue> <command:parameterValue required="false" variableLength="false">Tags</command:parameterValue> <command:parameterValue required="false" variableLength="false">Active</command:parameterValue> <command:parameterValue required="false" variableLength="false">Downtime</command:parameterValue> <command:parameterValue required="false" variableLength="false">TotalDowntime</command:parameterValue> <command:parameterValue required="false" variableLength="false">DownDuration</command:parameterValue> <command:parameterValue required="false" variableLength="false">Uptime</command:parameterValue> <command:parameterValue required="false" variableLength="false">TotalUptime</command:parameterValue> <command:parameterValue required="false" variableLength="false">UpDuration</command:parameterValue> <command:parameterValue required="false" variableLength="false">TotalMonitorTime</command:parameterValue> <command:parameterValue required="false" variableLength="false">DataCollectedSince</command:parameterValue> <command:parameterValue required="false" variableLength="false">Sensor</command:parameterValue> <command:parameterValue required="false" variableLength="false">Interval</command:parameterValue> <command:parameterValue required="false" variableLength="false">LastCheck</command:parameterValue> <command:parameterValue required="false" variableLength="false">LastUp</command:parameterValue> <command:parameterValue required="false" variableLength="false">LastDown</command:parameterValue> <command:parameterValue required="false" variableLength="false">Device</command:parameterValue> <command:parameterValue required="false" variableLength="false">Group</command:parameterValue> <command:parameterValue required="false" variableLength="false">Probe</command:parameterValue> <command:parameterValue required="false" variableLength="false">GrpDev</command:parameterValue> <command:parameterValue required="false" variableLength="false">NotificationTypes</command:parameterValue> <command:parameterValue required="false" variableLength="false">IntervalInherited</command:parameterValue> <command:parameterValue required="false" variableLength="false">Access</command:parameterValue> <command:parameterValue required="false" variableLength="false">Dependency</command:parameterValue> <command:parameterValue required="false" variableLength="false">Status</command:parameterValue> <command:parameterValue required="false" variableLength="false">Message</command:parameterValue> <command:parameterValue required="false" variableLength="false">Priority</command:parameterValue> <command:parameterValue required="false" variableLength="false">LastValue</command:parameterValue> <command:parameterValue required="false" variableLength="false">UpSensors</command:parameterValue> <command:parameterValue required="false" variableLength="false">DownSensors</command:parameterValue> <command:parameterValue required="false" variableLength="false">DownAcknowledgedSensors</command:parameterValue> <command:parameterValue required="false" variableLength="false">PartialDownSensors</command:parameterValue> <command:parameterValue required="false" variableLength="false">WarningSensors</command:parameterValue> <command:parameterValue required="false" variableLength="false">PausedSensors</command:parameterValue> <command:parameterValue required="false" variableLength="false">UnusualSensors</command:parameterValue> <command:parameterValue required="false" variableLength="false">UndefinedSensors</command:parameterValue> <command:parameterValue required="false" variableLength="false">TotalSensors</command:parameterValue> <command:parameterValue required="false" variableLength="false">Value</command:parameterValue> <command:parameterValue required="false" variableLength="false">Coverage</command:parameterValue> <command:parameterValue required="false" variableLength="false">Favorite</command:parameterValue> <command:parameterValue required="false" variableLength="false">UserName</command:parameterValue> <command:parameterValue required="false" variableLength="false">Parent</command:parameterValue> <command:parameterValue required="false" variableLength="false">DateTime</command:parameterValue> <command:parameterValue required="false" variableLength="false">DateOnly</command:parameterValue> <command:parameterValue required="false" variableLength="false">TimeOnly</command:parameterValue> <command:parameterValue required="false" variableLength="false">Schedule</command:parameterValue> <command:parameterValue required="false" variableLength="false">Period</command:parameterValue> <command:parameterValue required="false" variableLength="false">Email</command:parameterValue> <command:parameterValue required="false" variableLength="false">Template</command:parameterValue> <command:parameterValue required="false" variableLength="false">LastRun</command:parameterValue> <command:parameterValue required="false" variableLength="false">NextRun</command:parameterValue> <command:parameterValue required="false" variableLength="false">Size</command:parameterValue> <command:parameterValue required="false" variableLength="false">MiniGraph</command:parameterValue> <command:parameterValue required="false" variableLength="false">DeviceIcon</command:parameterValue> <command:parameterValue required="false" variableLength="false">Comments</command:parameterValue> <command:parameterValue required="false" variableLength="false">Host</command:parameterValue> <command:parameterValue required="false" variableLength="false">Condition</command:parameterValue> <command:parameterValue required="false" variableLength="false">BaseType</command:parameterValue> <command:parameterValue required="false" variableLength="false">Url</command:parameterValue> <command:parameterValue required="false" variableLength="false">Icon</command:parameterValue> <command:parameterValue required="false" variableLength="false">ParentId</command:parameterValue> <command:parameterValue required="false" variableLength="false">Location</command:parameterValue> <command:parameterValue required="false" variableLength="false">Collapsed</command:parameterValue> <command:parameterValue required="false" variableLength="false">TotalGroups</command:parameterValue> <command:parameterValue required="false" variableLength="false">TotalDevices</command:parameterValue> <command:parameterValue required="false" variableLength="false">TicketType</command:parameterValue> <command:parameterValue required="false" variableLength="false">ModifiedBy</command:parameterValue> <command:parameterValue required="false" variableLength="false">Actions</command:parameterValue> <command:parameterValue required="false" variableLength="false">Content</command:parameterValue> <command:parameterValue required="false" variableLength="false">Position</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: Operator --> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>Operator</maml:name> <maml:description> <maml:para>Operator to filter with.</maml:para> <maml:para>Possible values: Equals, NotEquals, GreaterThan, LessThan, Contains</maml:para> </maml:description> <command:parameterValue required="true">FilterOperator</command:parameterValue> <dev:type> <maml:name>PrtgAPI.FilterOperator</maml:name> <maml:uri /> <maml:description> <maml:para>Specifies operators that can be used for filtering results in a PRTG Request.</maml:para> </maml:description> </dev:type> <dev:defaultValue>Equals</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Equals</command:parameterValue> <command:parameterValue required="false" variableLength="false">NotEquals</command:parameterValue> <command:parameterValue required="false" variableLength="false">GreaterThan</command:parameterValue> <command:parameterValue required="false" variableLength="false">LessThan</command:parameterValue> <command:parameterValue required="false" variableLength="false">Contains</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: Value --> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="2"> <maml:name>Value</maml:name> <maml:description> <maml:para>Value to filter for.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Property --> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>Property</maml:name> <maml:description> <maml:para>Object property to filter on.</maml:para> <maml:para>Possible values: Id, Type, Name, Tags, Active, Downtime, TotalDowntime, DownDuration, Uptime, TotalUptime, UpDuration, TotalMonitorTime, DataCollectedSince, Sensor, Interval, LastCheck, LastUp, LastDown, Device, Group, Probe, GrpDev, NotificationTypes, IntervalInherited, Access, Dependency, Status, Message, Priority, LastValue, UpSensors, DownSensors, DownAcknowledgedSensors, PartialDownSensors, WarningSensors, PausedSensors, UnusualSensors, UndefinedSensors, TotalSensors, Value, Coverage, Favorite, UserName, Parent, DateTime, DateOnly, TimeOnly, Schedule, Period, Email, Template, LastRun, NextRun, Size, MiniGraph, DeviceIcon, Comments, Host, Condition, BaseType, Url, Icon, ParentId, Location, Collapsed, TotalGroups, TotalDevices, TicketType, ModifiedBy, Actions, Content, Position</maml:para> </maml:description> <command:parameterValue required="true">Property</command:parameterValue> <dev:type> <maml:name>PrtgAPI.Property</maml:name> <maml:uri /> <maml:description> <maml:para>Specifies properties (referred to by PRTG as "columns") that can be retrieved for a PRTG Object.</maml:para> </maml:description> </dev:type> <dev:defaultValue>Id</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Id</command:parameterValue> <command:parameterValue required="false" variableLength="false">Type</command:parameterValue> <command:parameterValue required="false" variableLength="false">Name</command:parameterValue> <command:parameterValue required="false" variableLength="false">Tags</command:parameterValue> <command:parameterValue required="false" variableLength="false">Active</command:parameterValue> <command:parameterValue required="false" variableLength="false">Downtime</command:parameterValue> <command:parameterValue required="false" variableLength="false">TotalDowntime</command:parameterValue> <command:parameterValue required="false" variableLength="false">DownDuration</command:parameterValue> <command:parameterValue required="false" variableLength="false">Uptime</command:parameterValue> <command:parameterValue required="false" variableLength="false">TotalUptime</command:parameterValue> <command:parameterValue required="false" variableLength="false">UpDuration</command:parameterValue> <command:parameterValue required="false" variableLength="false">TotalMonitorTime</command:parameterValue> <command:parameterValue required="false" variableLength="false">DataCollectedSince</command:parameterValue> <command:parameterValue required="false" variableLength="false">Sensor</command:parameterValue> <command:parameterValue required="false" variableLength="false">Interval</command:parameterValue> <command:parameterValue required="false" variableLength="false">LastCheck</command:parameterValue> <command:parameterValue required="false" variableLength="false">LastUp</command:parameterValue> <command:parameterValue required="false" variableLength="false">LastDown</command:parameterValue> <command:parameterValue required="false" variableLength="false">Device</command:parameterValue> <command:parameterValue required="false" variableLength="false">Group</command:parameterValue> <command:parameterValue required="false" variableLength="false">Probe</command:parameterValue> <command:parameterValue required="false" variableLength="false">GrpDev</command:parameterValue> <command:parameterValue required="false" variableLength="false">NotificationTypes</command:parameterValue> <command:parameterValue required="false" variableLength="false">IntervalInherited</command:parameterValue> <command:parameterValue required="false" variableLength="false">Access</command:parameterValue> <command:parameterValue required="false" variableLength="false">Dependency</command:parameterValue> <command:parameterValue required="false" variableLength="false">Status</command:parameterValue> <command:parameterValue required="false" variableLength="false">Message</command:parameterValue> <command:parameterValue required="false" variableLength="false">Priority</command:parameterValue> <command:parameterValue required="false" variableLength="false">LastValue</command:parameterValue> <command:parameterValue required="false" variableLength="false">UpSensors</command:parameterValue> <command:parameterValue required="false" variableLength="false">DownSensors</command:parameterValue> <command:parameterValue required="false" variableLength="false">DownAcknowledgedSensors</command:parameterValue> <command:parameterValue required="false" variableLength="false">PartialDownSensors</command:parameterValue> <command:parameterValue required="false" variableLength="false">WarningSensors</command:parameterValue> <command:parameterValue required="false" variableLength="false">PausedSensors</command:parameterValue> <command:parameterValue required="false" variableLength="false">UnusualSensors</command:parameterValue> <command:parameterValue required="false" variableLength="false">UndefinedSensors</command:parameterValue> <command:parameterValue required="false" variableLength="false">TotalSensors</command:parameterValue> <command:parameterValue required="false" variableLength="false">Value</command:parameterValue> <command:parameterValue required="false" variableLength="false">Coverage</command:parameterValue> <command:parameterValue required="false" variableLength="false">Favorite</command:parameterValue> <command:parameterValue required="false" variableLength="false">UserName</command:parameterValue> <command:parameterValue required="false" variableLength="false">Parent</command:parameterValue> <command:parameterValue required="false" variableLength="false">DateTime</command:parameterValue> <command:parameterValue required="false" variableLength="false">DateOnly</command:parameterValue> <command:parameterValue required="false" variableLength="false">TimeOnly</command:parameterValue> <command:parameterValue required="false" variableLength="false">Schedule</command:parameterValue> <command:parameterValue required="false" variableLength="false">Period</command:parameterValue> <command:parameterValue required="false" variableLength="false">Email</command:parameterValue> <command:parameterValue required="false" variableLength="false">Template</command:parameterValue> <command:parameterValue required="false" variableLength="false">LastRun</command:parameterValue> <command:parameterValue required="false" variableLength="false">NextRun</command:parameterValue> <command:parameterValue required="false" variableLength="false">Size</command:parameterValue> <command:parameterValue required="false" variableLength="false">MiniGraph</command:parameterValue> <command:parameterValue required="false" variableLength="false">DeviceIcon</command:parameterValue> <command:parameterValue required="false" variableLength="false">Comments</command:parameterValue> <command:parameterValue required="false" variableLength="false">Host</command:parameterValue> <command:parameterValue required="false" variableLength="false">Condition</command:parameterValue> <command:parameterValue required="false" variableLength="false">BaseType</command:parameterValue> <command:parameterValue required="false" variableLength="false">Url</command:parameterValue> <command:parameterValue required="false" variableLength="false">Icon</command:parameterValue> <command:parameterValue required="false" variableLength="false">ParentId</command:parameterValue> <command:parameterValue required="false" variableLength="false">Location</command:parameterValue> <command:parameterValue required="false" variableLength="false">Collapsed</command:parameterValue> <command:parameterValue required="false" variableLength="false">TotalGroups</command:parameterValue> <command:parameterValue required="false" variableLength="false">TotalDevices</command:parameterValue> <command:parameterValue required="false" variableLength="false">TicketType</command:parameterValue> <command:parameterValue required="false" variableLength="false">ModifiedBy</command:parameterValue> <command:parameterValue required="false" variableLength="false">Actions</command:parameterValue> <command:parameterValue required="false" variableLength="false">Content</command:parameterValue> <command:parameterValue required="false" variableLength="false">Position</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: Operator --> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>Operator</maml:name> <maml:description> <maml:para>Operator to filter with.</maml:para> <maml:para>Possible values: Equals, NotEquals, GreaterThan, LessThan, Contains</maml:para> </maml:description> <command:parameterValue required="true">FilterOperator</command:parameterValue> <dev:type> <maml:name>PrtgAPI.FilterOperator</maml:name> <maml:uri /> <maml:description> <maml:para>Specifies operators that can be used for filtering results in a PRTG Request.</maml:para> </maml:description> </dev:type> <dev:defaultValue>Equals</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Equals</command:parameterValue> <command:parameterValue required="false" variableLength="false">NotEquals</command:parameterValue> <command:parameterValue required="false" variableLength="false">GreaterThan</command:parameterValue> <command:parameterValue required="false" variableLength="false">LessThan</command:parameterValue> <command:parameterValue required="false" variableLength="false">Contains</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: Value --> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="2"> <maml:name>Value</maml:name> <maml:description> <maml:para>Value to filter for.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>PrtgAPI.Property</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Object property to filter on.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>PrtgAPI.FilterOperator</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Operator to filter with.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Value to filter for.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: SearchFilter --> <command:returnValue> <dev:type> <maml:name>PrtgAPI.SearchFilter</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Represents a filter used to limit search results returned by a PRTG Request.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>C:\> New-SearchFilter type contains deprecated | Get-Sensor</dev:code> <dev:remarks> <maml:para>Get all sensors whose type "deprecated"</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Get-Sensor</maml:linkText> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-Device</maml:linkText> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-Group</maml:linkText> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-Probe</maml:linkText> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Confirm-Sensor --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Confirm-Sensor</command:name> <command:verb>Confirm</command:verb> <command:noun>Sensor</command:noun> <maml:description> <maml:para>Marks a Down sensor as DownAcknowledged.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Acknowledge-Sensor cmdlet acknowledges a sensor that is currently in a 'Down' state. When a sensor is acknowledged, it no longer generates notification triggers and is moved from the 'Down' sensors page to the 'Down (Acknowledged)' sensors page.</maml:para> <maml:para>When acknowledging a sensor, you must specify how long to acknowledge the sensor for. If the sensor is still in a down state when the acknowledgement period expires, the sensor will return to a Down state. While in a Down (Acknowledged) state PRTG will continue refreshing the sensor according to its scanning interval. If at any time the requisite conditions are met for the sensor to enter an 'Up' state, the sensor will turn 'Up' and no further action will be required. If an acknowledged sensor that has gone Up fails and returns to a Down state, the sensor will need to be re-acknowledged.</maml:para> <maml:para>If a sensor is continually flapping, it may be better to pause the sensor rather than acknowledge it. For more information on pausing objects, see Pause-Object.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: Default --> <command:syntaxItem> <maml:name>Confirm-Sensor</maml:name> <!-- Parameter: Duration --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Duration</maml:name> <maml:description> <maml:para>The duration to acknowledge the sensor for, in minutes.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Sensor --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Sensor</maml:name> <maml:description> <maml:para>The sensor to acknowledge.</maml:para> </maml:description> <command:parameterValue required="true">Sensor</command:parameterValue> <dev:type> <maml:name>PrtgAPI.Sensor</maml:name> <maml:uri /> <maml:description> <maml:para>An object that monitors and collects information according to a defined schedule.</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: Message --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Message</maml:name> <maml:description> <maml:para>A message to display on the object indicating the reason it is acknowledged.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: Until --> <command:syntaxItem> <maml:name>Confirm-Sensor</maml:name> <!-- Parameter: Sensor --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Sensor</maml:name> <maml:description> <maml:para>The sensor to acknowledge.</maml:para> </maml:description> <command:parameterValue required="true">Sensor</command:parameterValue> <dev:type> <maml:name>PrtgAPI.Sensor</maml:name> <maml:uri /> <maml:description> <maml:para>An object that monitors and collects information according to a defined schedule.</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: Until --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Until</maml:name> <maml:description> <maml:para>The datetime at which the object should become unacknowledged.</maml:para> </maml:description> <command:parameterValue required="true">DateTime</command:parameterValue> <dev:type> <maml:name>System.DateTime</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Message --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Message</maml:name> <maml:description> <maml:para>A message to display on the object indicating the reason it is acknowledged.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: Forever --> <command:syntaxItem> <maml:name>Confirm-Sensor</maml:name> <!-- Parameter: Forever --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Forever</maml:name> <maml:description> <maml:para>Indicates the object should be acknowledged indefinitely.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Sensor --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Sensor</maml:name> <maml:description> <maml:para>The sensor to acknowledge.</maml:para> </maml:description> <command:parameterValue required="true">Sensor</command:parameterValue> <dev:type> <maml:name>PrtgAPI.Sensor</maml:name> <maml:uri /> <maml:description> <maml:para>An object that monitors and collects information according to a defined schedule.</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: Message --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Message</maml:name> <maml:description> <maml:para>A message to display on the object indicating the reason it is acknowledged.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Sensor --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Sensor</maml:name> <maml:description> <maml:para>The sensor to acknowledge.</maml:para> </maml:description> <command:parameterValue required="true">Sensor</command:parameterValue> <dev:type> <maml:name>PrtgAPI.Sensor</maml:name> <maml:uri /> <maml:description> <maml:para>An object that monitors and collects information according to a defined schedule.</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: Message --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Message</maml:name> <maml:description> <maml:para>A message to display on the object indicating the reason it is acknowledged.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Duration --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Duration</maml:name> <maml:description> <maml:para>The duration to acknowledge the sensor for, in minutes.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Until --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Until</maml:name> <maml:description> <maml:para>The datetime at which the object should become unacknowledged.</maml:para> </maml:description> <command:parameterValue required="true">DateTime</command:parameterValue> <dev:type> <maml:name>System.DateTime</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Forever --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Forever</maml:name> <maml:description> <maml:para>Indicates the object should be acknowledged indefinitely.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>PrtgAPI.Sensor</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The sensor to acknowledge.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>C:\> Get-Sensor -Status Down | Acknowledge-Sensor -Duration 60</dev:code> <dev:remarks> <maml:para>Acknowledge all down sensors for the next 60 minutes</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>C:\> Get-Sensor -Status Down | Acknowledge-Sensor -Until (Get-Date).AddDays(30) -Message "Honestly, CBF"</dev:code> <dev:remarks> <maml:para>Acknowledge all down sensors for the next 30 days with a message explaining the reason the sensor was acknowledged</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 3 ----------</maml:title> <dev:code>C:\> Get-Sensor Ping -Status Down | Acknowledge-Sensor -Forever</dev:code> <dev:remarks> <maml:para>Acknowledge all down ping sensors forever (or until they comes back up by themselves)</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Get-Sensor</maml:linkText> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Pause-Object</maml:linkText> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Copy-Sensor --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Copy-Sensor</command:name> <command:verb>Copy</command:verb> <command:noun>Sensor</command:noun> <maml:description> <maml:para>Clones a sensor within PRTG.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Clone-Sensor cmdlet duplicates a PRTG Sensor, including all channels defined under it.</maml:para> <maml:para>To clone a sensor, you must specify the Object ID of the device the cloned sensor will sit under. If a Name is not specified, the name of the sensor being cloned will be used.</maml:para> <maml:para>When a sensor has been cloned, by default Clone-Sensor will attempt to resolve the object into a PrtgAPI Sensor. Based on the speed of your PRTG Server, this can sometimes result in a delay of 5-10 seconds due to the delay with which PRTG clones the object. If Clone-Sensor cannot resolve the resultant object on the first attempt, PrtgAPI will make a further 10 retries, pausing for a successively greater duration between each try. After each failed attempt a warning will be displayed indicating the number of attempts remaining. Object resolution can be aborted at any time by pressing an escape sequence such as Ctrl+C.</maml:para> <maml:para>If you do not wish to resolve the resultant object, you can specify -Resolve:$false, which will cause Clone-Sensor to output a clone summary, including the object ID and name of the new object. As PRTG pauses all cloned objects by default, it is generally recommended to resolve the new object so that you may unpause the object with Resume-Object.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Copy-Sensor</maml:name> <!-- Parameter: DestinationId --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>DestinationId</maml:name> <maml:description> <maml:para>The ID of the device (for sensors), group or probe (for groups and devices) that will hold the cloned object.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: Name --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name to rename the cloned object to.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Sensor --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Sensor</maml:name> <maml:description> <maml:para>The sensor to clone.</maml:para> </maml:description> <command:parameterValue required="true">Sensor</command:parameterValue> <dev:type> <maml:name>PrtgAPI.Sensor</maml:name> <maml:uri /> <maml:description> <maml:para>An object that monitors and collects information according to a defined schedule.</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: Resolve --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Resolve</maml:name> <maml:description> <maml:para>Indicates whether or not the cloned object should be resolved into a PrtgObject. By default this value is true (perform resolution). If this value is false, a summary of the clone operation will be provided.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>True</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Sensor --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Sensor</maml:name> <maml:description> <maml:para>The sensor to clone.</maml:para> </maml:description> <command:parameterValue required="true">Sensor</command:parameterValue> <dev:type> <maml:name>PrtgAPI.Sensor</maml:name> <maml:uri /> <maml:description> <maml:para>An object that monitors and collects information according to a defined schedule.</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: DestinationId --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>DestinationId</maml:name> <maml:description> <maml:para>The ID of the device (for sensors), group or probe (for groups and devices) that will hold the cloned object.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: Name --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name to rename the cloned object to.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Resolve --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Resolve</maml:name> <maml:description> <maml:para>Indicates whether or not the cloned object should be resolved into a PrtgObject. By default this value is true (perform resolution). If this value is false, a summary of the clone operation will be provided.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>True</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>PrtgAPI.Sensor</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The sensor to clone.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: Sensor --> <command:returnValue> <dev:type> <maml:name>PrtgAPI.Sensor</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>An object that monitors and collects information according to a defined schedule.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>C:\> Get-Sensor -Id 1234 | Clone-Sensor 5678</dev:code> <dev:remarks> <maml:para>Clone the sensor with ID 1234 to the device with ID 5678</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>C:\> Get-Sensor -Id 1234 | Clone-Sensor 5678 MyNewSensor</dev:code> <dev:remarks> <maml:para>Clone the sensor with ID 1234 to the device with ID 5678 renamed as "MyNewSensor"</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 3 ----------</maml:title> <dev:code>C:\> Get-Sensor -Id 1234 | Clone-Sensor 5678 -Resolve:$false</dev:code> <dev:remarks> <maml:para>Clone the sensor with ID 1234 into the device with ID 5678 without resolving the resultant PrtgObject</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Get-Sensor</maml:linkText> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Clone-Device</maml:linkText> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Clone-Group</maml:linkText> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Resume-Object</maml:linkText> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Get-Sensor --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-Sensor</command:name> <command:verb>Get</command:verb> <command:noun>Sensor</command:noun> <maml:description> <maml:para>Retrieves sensors from a PRTG Server.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Get-Sensor cmdlet retrieves sensors from a PRTG Server. Sensors are the fundamental unit of monitoring in PRTG, and the most populous type of object in the system by far. Get-Sensor provides a variety of methods of filtering the sensors requested from PRTG, including by sensor name, ID, status and tags as well as parent probe/group/device. Multiple filters can be used in conjunction to further limit the number of results returned.</maml:para> <maml:para>For scenarios in which you wish to filter on properties not covered by parameters available in Get-Sensor, a custom SearchFilter object can be created specifying the field name, condition and value to filter upon. For information on properties that can be filtered on, see New-SearchFilter. When searching for Sensor Factory objects, please note that these objects do not respond to server side filters by "type". To filter for Sensor Factory sensors, filter by the tag "factorysensor".</maml:para> <maml:para>When invoked with no arguments, Get-Sensor will query the number of sensors present on your PRTG Server. If PrtgAPI detects the number is about a specified threshold, PrtgAPI will split the request up into several smaller requests which will each be invoked in parallel. Results will then be "streamed" to the pipeline in the order they arrive. A progress bar will also be visible up the top indicating the total number of sensors retrieved/remaining.</maml:para> <maml:para>If you attempt to cancel a large request (Ctrl+C) and immediately issue another request (of any size), PRTG may fail to immediately respond until it has finished processing the request you initially issued. Please keep this in mind when dealing with systems with an extreme number of sensors (>10,000).</maml:para> <maml:para>The Sensor objects returned from Get-Sensor can be piped to a variety of other cmdlets for further processing, including Get-Channel, wherein the ID of the sensor will be used to acquire its underlying channels.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Get-Sensor</maml:name> <!-- Parameter: Name --> <command:parameter required="false" globbing="false" pipelineInput="false" position="0"> <maml:name>Name</maml:name> <maml:description> <maml:para>Filter the response to objects with a certain name. Can include wildcards.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Filter --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="1"> <maml:name>Filter</maml:name> <maml:description> <maml:para>Filter the response to objects that match one or more criteria.</maml:para> </maml:description> <command:parameterValue required="true">SearchFilter[]</command:parameterValue> <dev:type> <maml:name>PrtgAPI.SearchFilter[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Count --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Count</maml:name> <maml:description> <maml:para>Maximum number of results to return.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Device --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Device</maml:name> <maml:description> <maml:para>The device to retrieve sensors for.</maml:para> </maml:description> <command:parameterValue required="true">Device</command:parameterValue> <dev:type> <maml:name>PrtgAPI.Device</maml:name> <maml:uri /> <maml:description> <maml:para>A computer or piece of equipment containing one or more sensors monitored by PRTG.</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: Group --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Group</maml:name> <maml:description> <maml:para>The group to retrieve sensors for.</maml:para> </maml:description> <command:parameterValue required="true">Group</command:parameterValue> <dev:type> <maml:name>PrtgAPI.Group</maml:name> <maml:uri /> <maml:description> <maml:para>A group used to organize one or more devices.</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: Id --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Id</maml:name> <maml:description> <maml:para>Retrieve an object with a specified ID.</maml:para> </maml:description> <command:parameterValue required="true">Nullable`1[]</command:parameterValue> <dev:type> <maml:name>System.Nullable`1[[System.Int32, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]][]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Probe --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Probe</maml:name> <maml:description> <maml:para>The probe to retrieve sensors for.</maml:para> </maml:description> <command:parameterValue required="true">Probe</command:parameterValue> <dev:type> <maml:name>PrtgAPI.Probe</maml:name> <maml:uri /> <maml:description> <maml:para>A device used to perform monitoring against a site or set of systems.</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: Status --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Status</maml:name> <maml:description> <maml:para>Only retrieve objects that match a specific status.</maml:para> </maml:description> <command:parameterValue required="true">Status[]</command:parameterValue> <dev:type> <maml:name>PrtgAPI.Status[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Tags --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Tags</maml:name> <maml:description> <maml:para>Filter the response to objects with certain tags. Can include wildcards.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Device --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Device</maml:name> <maml:description> <maml:para>The device to retrieve sensors for.</maml:para> </maml:description> <command:parameterValue required="true">Device</command:parameterValue> <dev:type> <maml:name>PrtgAPI.Device</maml:name> <maml:uri /> <maml:description> <maml:para>A computer or piece of equipment containing one or more sensors monitored by PRTG.</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: Probe --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Probe</maml:name> <maml:description> <maml:para>The probe to retrieve sensors for.</maml:para> </maml:description> <command:parameterValue required="true">Probe</command:parameterValue> <dev:type> <maml:name>PrtgAPI.Probe</maml:name> <maml:uri /> <maml:description> <maml:para>A device used to perform monitoring against a site or set of systems.</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: Group --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Group</maml:name> <maml:description> <maml:para>The group to retrieve sensors for.</maml:para> </maml:description> <command:parameterValue required="true">Group</command:parameterValue> <dev:type> <maml:name>PrtgAPI.Group</maml:name> <maml:uri /> <maml:description> <maml:para>A group used to organize one or more devices.</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: Name --> <command:parameter required="false" globbing="false" pipelineInput="false" position="0"> <maml:name>Name</maml:name> <maml:description> <maml:para>Filter the response to objects with a certain name. Can include wildcards.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Id --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Id</maml:name> <maml:description> <maml:para>Retrieve an object with a specified ID.</maml:para> </maml:description> <command:parameterValue required="true">Nullable`1[]</command:parameterValue> <dev:type> <maml:name>System.Nullable`1[[System.Int32, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]][]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Filter --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="1"> <maml:name>Filter</maml:name> <maml:description> <maml:para>Filter the response to objects that match one or more criteria.</maml:para> </maml:description> <command:parameterValue required="true">SearchFilter[]</command:parameterValue> <dev:type> <maml:name>PrtgAPI.SearchFilter[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Tags --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Tags</maml:name> <maml:description> <maml:para>Filter the response to objects with certain tags. Can include wildcards.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Status --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Status</maml:name> <maml:description> <maml:para>Only retrieve objects that match a specific status.</maml:para> </maml:description> <command:parameterValue required="true">Status[]</command:parameterValue> <dev:type> <maml:name>PrtgAPI.Status[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Count --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Count</maml:name> <maml:description> <maml:para>Maximum number of results to return.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>PrtgAPI.Device</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The device to retrieve sensors for.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>PrtgAPI.Probe</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The probe to retrieve sensors for.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>PrtgAPI.Group</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The group to retrieve sensors for.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>PrtgAPI.SearchFilter[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Filter the response to objects that match one or more criteria.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>PrtgAPI.Status[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Only retrieve objects that match a specific status.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: Sensor --> <command:returnValue> <dev:type> <maml:name>PrtgAPI.Sensor</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>An object that monitors and collects information according to a defined schedule.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>C:\> Get-Sensor Ping</dev:code> <dev:remarks> <maml:para>Get all sensors named "Ping" (case insensitive)</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>C:\> Get-Sensor *cpu*</dev:code> <dev:remarks> <maml:para>Get all sensors whose name contains "cpu" (case insensitive)</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 3 ----------</maml:title> <dev:code>C:\> Get-Sensor -Id 2001</dev:code> <dev:remarks> <maml:para>Get the sensor with ID 2001</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 4 ----------</maml:title> <dev:code>C:\> Get-Sensor -Status Down</dev:code> <dev:remarks> <maml:para>Get all sensors in a "Down" status.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 5 ----------</maml:title> <dev:code>C:\> Get-Device *fw* | Get-Sensor Ping</dev:code> <dev:remarks> <maml:para>Get all sensors named "Ping" (case insensitive) from all devices whose name contains "fw"</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 6 ----------</maml:title> <dev:code>C:\> Get-Sensor -Tags wmimemorysensor</dev:code> <dev:remarks> <maml:para>Get all sensors that have the tag "wmimemorysensor"</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 7 ----------</maml:title> <dev:code>C:\> Get-Sensor -Count 1</dev:code> <dev:remarks> <maml:para>Get only 1 sensor from PRTG.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 8 ----------</maml:title> <dev:code>C:\> New-SearchFilter type contains deprecated | Get-Sensor</dev:code> <dev:remarks> <maml:para>Get all deprecated sensors.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Get-Device</maml:linkText> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-Group</maml:linkText> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-Probe</maml:linkText> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-Channel</maml:linkText> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-SearchFilter</maml:linkText> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: New-SensorFactoryDefinition --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>New-SensorFactoryDefinition</command:name> <command:verb>New</command:verb> <command:noun>SensorFactoryDefinition</command:noun> <maml:description> <maml:para>Creates a channel definition for use in a Sensor Factory.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The New-SensorFactoryDefinition cmdlet automatically defines a series of channel defitions for use in a Sensor Factory sensor.</maml:para> <maml:para>New-SensorFactoryDefinition can be used to create both individual channel definitions for a collection of sensors, as well as aggregation sensors, using a complex formula that operates on all of the sensors in a set.</maml:para> <maml:para>When specifying an Expression, the default expression and current sensor can be accessed via the $expr and $_ automatic variables. Unless you wish to modify the sensor ID or channel ID to be used for a specific sensor, it is generally recommended to avoid recalculating the base channel definition and use the automatic $expr variable, which is defined as "channel(sensorId, channelID)" where sensorID is the ID of the current sensor, and channelID is the value passed to -ChannelID.</maml:para> <maml:para>When specifying an Aggregator, the running accumulator, default expression and current sensor can be accessed via the $acc, $expr and $_ automatic variables respectively. Based on whether not the -Expression parameter is specified, $expr will either contain the custom or the default expression.</maml:para> <maml:para>While it is possible to override the expression evaluated in $expr in the Aggregator by recalculating the channel definition (via the $_ automatic variable), if the channel ID specified in the new definition is different from the channel ID specified in the -ChannelID parameter, the first channel definition in the resulting output will have a different channel ID than all the rest. This is due to the fact when the Aggregator runs, it initially sets the accumulator ($acc) to the expression of the first sensor. As such, if in the Aggregator you change the channel ID, you will also need to replace the channel ID of the initial value in the accumulator. Due to the complexity involved in managing this, it is recommended to avoid modifying the channel ID in the aggregator, and either set the channel ID in an -Expression or in the -ChannelID.</maml:para> <maml:para>Both -Expression and -Aggregator support the use of Sensor Factory formula functions (channel(), min(), max(), avg() and percent()), as well as all boolean and math operators. For more information, see the PRTG Manual Sensor Factory documentation.</maml:para> <maml:para>Generating horizontal lines is not supported. To include horizontal lines in your sensor factory you must create the horizontal line channel definition manually. It does not matter what the ID of any horizontal lines are, as long as they do not conflict with any other channel definitions.</maml:para> <maml:para>To automatically copy the output of New-SensorFactoryDefinition to the clipboard, you can pipe the cmdlet to clip.exe.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: Aggregate --> <command:syntaxItem> <maml:name>New-SensorFactoryDefinition</maml:name> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>Name</maml:name> <maml:description> <maml:para>An expression that resolves the name to use for a channel definition.</maml:para> </maml:description> <command:parameterValue required="true">ScriptBlock</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.ScriptBlock</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ChannelId --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>ChannelId</maml:name> <maml:description> <maml:para>The channel ID to use. If a custom expression is provided, this value can be optionally overridden.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: Item --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Item</maml:name> <maml:description> <maml:para>The sensor to create a channel definition for.</maml:para> </maml:description> <command:parameterValue required="true">Sensor</command:parameterValue> <dev:type> <maml:name>PrtgAPI.Sensor</maml:name> <maml:uri /> <maml:description> <maml:para>An object that monitors and collects information according to a defined schedule.</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: Aggregator --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Aggregator</maml:name> <maml:description> <maml:para>An aggregator to use for creating a single aggregation channel.</maml:para> <maml:para>Provides the fllowing automatic variables:</maml:para> <maml:para>'$acc' (the running accumulator)</maml:para> <maml:para>'$expr' (for the default expression)</maml:para> <maml:para>'$_' (the current sensor</maml:para> </maml:description> <command:parameterValue required="true">ScriptBlock</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.ScriptBlock</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Expression --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Expression</maml:name> <maml:description> <maml:para>A custom expression to use for defining a channel definition.</maml:para> <maml:para>Provides the following automatic variables</maml:para> <maml:para>'$expr' (for the default expression)</maml:para> <maml:para>'$_' (for the current sensor)</maml:para> </maml:description> <command:parameterValue required="true">ScriptBlock</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.ScriptBlock</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Finalizer --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Finalizer</maml:name> <maml:description> <maml:para>A post-processing action to perform on an aggregated expresion before emititing to the pipeline.</maml:para> <maml:para>Provides the following automatic variables:</maml:para> <maml:para>'$acc' (the accumulated result)</maml:para> </maml:description> <command:parameterValue required="true">ScriptBlock</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.ScriptBlock</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: StartIndex --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>StartIndex</maml:name> <maml:description> <maml:para>The start index to use for each channel definition. The default value is 1.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>1</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Item --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Item</maml:name> <maml:description> <maml:para>The sensor to create a channel definition for.</maml:para> </maml:description> <command:parameterValue required="true">Sensor</command:parameterValue> <dev:type> <maml:name>PrtgAPI.Sensor</maml:name> <maml:uri /> <maml:description> <maml:para>An object that monitors and collects information according to a defined schedule.</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>Name</maml:name> <maml:description> <maml:para>An expression that resolves the name to use for a channel definition.</maml:para> </maml:description> <command:parameterValue required="true">ScriptBlock</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.ScriptBlock</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ChannelId --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>ChannelId</maml:name> <maml:description> <maml:para>The channel ID to use. If a custom expression is provided, this value can be optionally overridden.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: Expression --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Expression</maml:name> <maml:description> <maml:para>A custom expression to use for defining a channel definition.</maml:para> <maml:para>Provides the following automatic variables</maml:para> <maml:para>'$expr' (for the default expression)</maml:para> <maml:para>'$_' (for the current sensor)</maml:para> </maml:description> <command:parameterValue required="true">ScriptBlock</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.ScriptBlock</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: StartIndex --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>StartIndex</maml:name> <maml:description> <maml:para>The start index to use for each channel definition. The default value is 1.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>1</dev:defaultValue> </command:parameter> <!-- Parameter: Aggregator --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Aggregator</maml:name> <maml:description> <maml:para>An aggregator to use for creating a single aggregation channel.</maml:para> <maml:para>Provides the fllowing automatic variables:</maml:para> <maml:para>'$acc' (the running accumulator)</maml:para> <maml:para>'$expr' (for the default expression)</maml:para> <maml:para>'$_' (the current sensor</maml:para> </maml:description> <command:parameterValue required="true">ScriptBlock</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.ScriptBlock</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Finalizer --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Finalizer</maml:name> <maml:description> <maml:para>A post-processing action to perform on an aggregated expresion before emititing to the pipeline.</maml:para> <maml:para>Provides the following automatic variables:</maml:para> <maml:para>'$acc' (the accumulated result)</maml:para> </maml:description> <command:parameterValue required="true">ScriptBlock</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.ScriptBlock</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>PrtgAPI.Sensor</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The sensor to create a channel definition for.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>C:\> Get-Sensor -Tags wmicpuloadsensor | New-SensorFactoryDefinition { $_.Device } 0</dev:code> <dev:remarks> <maml:para>Create a channel definition for the "Total" channel (ID: 0) of each WMI CPU Load sensor in the system</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>C:\> Get-Sensor -Tags wmimemorysensor | New-SensorFactoryDefinition { $_.Device } -Expr { 100 - $expr } 0</dev:code> <dev:remarks> <maml:para>Create a channel definition for the "Percent Available Memory" channel (ID: 0) of each WMI Memory Free sensor, modifying each channel to show the percent of memory "free" instead of used</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 3 ----------</maml:title> <dev:code>C:\> $sensors = Get-Sensor -Tags wmicpuloadsensor</dev:code> <dev:remarks> <maml:para>C:\> $sensors | New-SensorFactoryDefinition { "Max CPU Load" } -Aggregator { "max($expr,$acc)" }</maml:para> <maml:para>C:\> $sensors | New-SensorFactoryDefinition { $_.Device } -StartIndex 2</maml:para> <maml:para>Create a channel definition for showing the highest CPU Load of all sensors as well as channel definitions for each individual sensor</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 4 ----------</maml:title> <dev:code>C:\> Get-Sensor -Tags wmicpuloadsensor | New-SensorFactoryDefinition { "$($_.Device) [bananas]" } 0</dev:code> <dev:remarks> <maml:para>Create a channel definition for the "Total" channel (ID: 0) displaying all channels with the custom unit "bananas"</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Get-Sensor</maml:linkText> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-Channel</maml:linkText> </maml:navigationLink> <maml:navigationLink> <maml:linkText>https://www.paessler.com/manuals/prtg/sensor_factory_sensor</maml:linkText> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Get-SensorHistory --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-SensorHistory</command:name> <command:verb>Get</command:verb> <command:noun>SensorHistory</command:noun> <maml:description> <maml:para>Retrieves historic data values for a PRTG Sensor.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Get-SensorHistory cmdlet retrieves historic data values for all channels of a PRTG Sensor within a specified time period. By default, values are returned according to the scanning interval defined on the sensor (e.g. values every 60 seconds). Using the -Average parameter, values can be averaged together to provide a higher level view of a larger time span. Any number of seconds can be specified as the Average, however note that depending on the interval of the sensor, certain time spans may result in blank values within the sensor results.</maml:para> <maml:para>Historic data values can be retrieved over any time period via the StartDate and EndDate parameters. If these values are not overwritten, they will default to 24 hours ago and Now (the time the cmdlet was executed) respectively. If PRTG finds it does not have enough monitoring data to return for the specified time span, an exception will be thrown. To work around this, you can request date for a larger time frame and then potentially filter the data with the Where-Object and Select-Object cmdlets.</maml:para> <maml:para>PrtgAPI will automatically display all numeric channel values as numbers, with the unit of the channel displayed in brackets next to the channel header (e.g. "Total(%)"). These units are for display purposes only, and so can be ignored when attempting to extract certain columns from the sensor history result.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: Default --> <command:syntaxItem> <maml:name>Get-SensorHistory</maml:name> <!-- Parameter: Sensor --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Sensor</maml:name> <maml:description> <maml:para>Sensor to retrieve historic data for.</maml:para> </maml:description> <command:parameterValue required="true">Sensor</command:parameterValue> <dev:type> <maml:name>PrtgAPI.Sensor</maml:name> <maml:uri /> <maml:description> <maml:para>An object that monitors and collects information according to a defined schedule.</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: Average --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Average</maml:name> <maml:description> <maml:para>Time span (in seconds) to average results over. For example, a value of 300 will show the average value every 5 minutes.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: EndDate --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>EndDate</maml:name> <maml:description> <maml:para>End time to retrieve history to. If no value is specified, defaults to the current date and time.</maml:para> </maml:description> <command:parameterValue required="true">DateTime</command:parameterValue> <dev:type> <maml:name>System.DateTime</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: StartDate --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>StartDate</maml:name> <maml:description> <maml:para>Start time to retrieve history from. If no value is specified, defaults to 24 hours ago.</maml:para> </maml:description> <command:parameterValue required="true">DateTime</command:parameterValue> <dev:type> <maml:name>System.DateTime</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: Manual --> <command:syntaxItem> <maml:name>Get-SensorHistory</maml:name> <!-- Parameter: Id --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Id</maml:name> <maml:description> <maml:para>ID of the sensor to retrieve historic data for.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: Average --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Average</maml:name> <maml:description> <maml:para>Time span (in seconds) to average results over. For example, a value of 300 will show the average value every 5 minutes.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: EndDate --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>EndDate</maml:name> <maml:description> <maml:para>End time to retrieve history to. If no value is specified, defaults to the current date and time.</maml:para> </maml:description> <command:parameterValue required="true">DateTime</command:parameterValue> <dev:type> <maml:name>System.DateTime</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: StartDate --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>StartDate</maml:name> <maml:description> <maml:para>Start time to retrieve history from. If no value is specified, defaults to 24 hours ago.</maml:para> </maml:description> <command:parameterValue required="true">DateTime</command:parameterValue> <dev:type> <maml:name>System.DateTime</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Sensor --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Sensor</maml:name> <maml:description> <maml:para>Sensor to retrieve historic data for.</maml:para> </maml:description> <command:parameterValue required="true">Sensor</command:parameterValue> <dev:type> <maml:name>PrtgAPI.Sensor</maml:name> <maml:uri /> <maml:description> <maml:para>An object that monitors and collects information according to a defined schedule.</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: Id --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Id</maml:name> <maml:description> <maml:para>ID of the sensor to retrieve historic data for.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: StartDate --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>StartDate</maml:name> <maml:description> <maml:para>Start time to retrieve history from. If no value is specified, defaults to 24 hours ago.</maml:para> </maml:description> <command:parameterValue required="true">DateTime</command:parameterValue> <dev:type> <maml:name>System.DateTime</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: EndDate --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>EndDate</maml:name> <maml:description> <maml:para>End time to retrieve history to. If no value is specified, defaults to the current date and time.</maml:para> </maml:description> <command:parameterValue required="true">DateTime</command:parameterValue> <dev:type> <maml:name>System.DateTime</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Average --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Average</maml:name> <maml:description> <maml:para>Time span (in seconds) to average results over. For example, a value of 300 will show the average value every 5 minutes.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>PrtgAPI.Sensor</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Sensor to retrieve historic data for.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>Get-Sensor -Id 1001 | Get-SensorHistory</dev:code> <dev:remarks> <maml:para>Get historical values for all channels on the sensor with ID 1001 over the past 24 hours, using the sensor's default interval.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>Get-Sensor -Id 1001 | Get-SensorHistory -Average 300</dev:code> <dev:remarks> <maml:para>Get historical values for all channels on the sensor with ID 1001 over the past 24 hours, averaging values in 5 minute intervals.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 3 ----------</maml:title> <dev:code>Get-Sensor -Id 1001 | Get-SensorHistory -StartDate (Get-Date).AddDays(-3) -EndDate (Get-Date).AddDays(-1)</dev:code> <dev:remarks> <maml:para>Get historical values for all channels on the sensor with ID 1001 starting three days ago and ending yesterday.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 4 ----------</maml:title> <dev:code>Get-Sensor -Tags wmicpu* -count 1 | Get-SensorHistory | select Total</dev:code> <dev:remarks> <maml:para>Get historical values for all channels on a single WMI CPU Load sensor, selecting the "Total" channel (visually displayed as "Total(%)"</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 5 ----------</maml:title> <dev:code>Get-Sensor -Tags wmicpu* -count 1 | where Total -gt 90</dev:code> <dev:remarks> <maml:para>Get historical values for all channels on a single WMI CPU Load sensor where the Total channel's value was greater than 90.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Get-Sensor</maml:linkText> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Select-Object</maml:linkText> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Where-Object</maml:linkText> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Get-SensorTotals --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-SensorTotals</command:name> <command:verb>Get</command:verb> <command:noun>SensorTotals</command:noun> <maml:description> <maml:para>Retrieves the total number of each type of sensor in the system.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Get-SensorTotals cmdlet retrieves the total number of each type of sensor in a PRTG Server.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Get-SensorTotals</maml:name> </command:syntaxItem> </command:syntax> <command:parameters /> <command:inputTypes /> <command:returnValues> <!-- OutputType: SensorTotals --> <command:returnValue> <dev:type> <maml:name>PrtgAPI.SensorTotals</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>Get-SensorTotals</dev:code> <dev:remarks> <maml:para>Count the number of sensors in the system.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Get-Sensor</maml:linkText> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Start-SortPrtgObject --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Start-SortPrtgObject</command:name> <command:verb>Start</command:verb> <command:noun>SortPrtgObject</command:noun> <maml:description> <maml:para>Sorts the children of a device, group or probe alphabetically.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Start-SortPrtgObject</maml:name> <!-- Parameter: Object --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Object</maml:name> <maml:description> <maml:para>The device, group or probe whose children should be sorted.</maml:para> </maml:description> <command:parameterValue required="true">DeviceOrGroupOrProbe</command:parameterValue> <dev:type> <maml:name>PrtgAPI.Objects.Shared.DeviceOrGroupOrProbe</maml:name> <maml:uri /> <maml:description> <maml:para>Properties that apply to Devices, Groups and Probes.</maml:para> </maml:description> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Object --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Object</maml:name> <maml:description> <maml:para>The device, group or probe whose children should be sorted.</maml:para> </maml:description> <command:parameterValue required="true">DeviceOrGroupOrProbe</command:parameterValue> <dev:type> <maml:name>PrtgAPI.Objects.Shared.DeviceOrGroupOrProbe</maml:name> <maml:uri /> <maml:description> <maml:para>Properties that apply to Devices, Groups and Probes.</maml:para> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>PrtgAPI.Objects.Shared.DeviceOrGroupOrProbe</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The device, group or probe whose children should be sorted.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>C:\> Get-Group -Id 0 | Sort-PrtgObject</dev:code> <dev:remarks> <maml:para>Sort all probes under the root PRTG Group</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> </helpItems> |