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> <!-- Parameter: PassThru --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PassThru</maml:name> <maml:description> <maml:para>Specifies whether to return the original PrtgObject that was passed to this cmdlet, allowing the object to be further piped into additional cmdlets.</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: 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> <!-- Parameter: PassThru --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PassThru</maml:name> <maml:description> <maml:para>Specifies whether to return the original PrtgObject that was passed to this cmdlet, allowing the object to be further piped into additional cmdlets.</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.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: DefaultSet --> <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: ManualSet --> <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 PRTG 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:para>By default, Set-ChannelProperty will operate in Batch Mode. In Batch Mode, Set-ChannelProperty will not execute a request for each individual object, but will rather store each item in a queue to modify channel properties for all objects at once, via a single request. This allows PrtgAPI to be extremely performant in performing operations against a large number of objects.</maml:para> <maml:para>If the pipeline is cancelled (either due to a cmdlet throwing an exception or the user pressing Ctrl-C) before fully completing, Set-ChannelProperty will not generate a request against PRTG. If you wish to disable Batch Mode and fully process objects individually one at a time, this can be achieved by specifying -Batch:$false.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: DefaultSet --> <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: Batch --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Batch</maml:name> <maml:description> <maml:para>Specifies whether this cmdlet should queue all objects piped to this cmdlet to execute a single request against PRTG for processing all objects. By default this value is true.</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> <!-- 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: PassThru --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PassThru</maml:name> <maml:description> <maml:para>Specifies whether to return the original PrtgObject that was passed to this cmdlet, allowing the object to be further piped into additional cmdlets.</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> <!-- Parameter set: DynamicSet --> <command:syntaxItem> <maml:name>Set-ChannelProperty</maml:name> <!-- Parameter: Batch --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Batch</maml:name> <maml:description> <maml:para>Specifies whether this cmdlet should queue all objects piped to this cmdlet to execute a single request against PRTG for processing all objects. By default this value is true.</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> <!-- 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: PassThru --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PassThru</maml:name> <maml:description> <maml:para>Specifies whether to return the original PrtgObject that was passed to this cmdlet, allowing the object to be further piped into additional cmdlets.</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> <!-- Parameter set: ManualSet --> <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> <dev:defaultValue>0</dev:defaultValue> </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> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: Batch --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Batch</maml:name> <maml:description> <maml:para>Specifies whether this cmdlet should queue all objects piped to this cmdlet to execute a single request against PRTG for processing all objects. By default this value is true.</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> <!-- Parameter: PassThru --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PassThru</maml:name> <maml:description> <maml:para>Specifies whether to return the original PrtgObject that was passed to this cmdlet, allowing the object to be further piped into additional cmdlets.</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> <!-- Parameter set: DynamicManualSet --> <command:syntaxItem> <maml:name>Set-ChannelProperty</maml:name> <!-- 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> <dev:defaultValue>0</dev:defaultValue> </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> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: Batch --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Batch</maml:name> <maml:description> <maml:para>Specifies whether this cmdlet should queue all objects piped to this cmdlet to execute a single request against PRTG for processing all objects. By default this value is true.</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> <!-- Parameter: PassThru --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PassThru</maml:name> <maml:description> <maml:para>Specifies whether to return the original PrtgObject that was passed to this cmdlet, allowing the object to be further piped into additional cmdlets.</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: 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> <dev:defaultValue>0</dev:defaultValue> </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> <dev:defaultValue>0</dev:defaultValue> </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> <!-- Parameter: Batch --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Batch</maml:name> <maml:description> <maml:para>Specifies whether this cmdlet should queue all objects piped to this cmdlet to execute a single request against PRTG for processing all objects. By default this value is true.</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> <!-- Parameter: PassThru --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PassThru</maml:name> <maml:description> <maml:para>Specifies whether to return the original PrtgObject that was passed to this cmdlet, allowing the object to be further piped into additional cmdlets.</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.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>Get-Help 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: Add-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>Add-Device</command:name> <command:verb>Add</command:verb> <command:noun>Device</command:noun> <maml:description> <maml:para>Adds a new device to a PRTG Group or Probe.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Add-Device cmdlet adds a new device to a PRTG Group or Probe. When adding a new device, Add-Device supports two methods of specifying the parameters required to create the object. For basic scenarios where you wish to inherit all settings from the parent object, the Name, Host and auto-discovery method can all be specified as arguments directly to Add-Device. If a -Host is not specified, Add-Device will automatically use the -Name as the device's hostname. If -AutoDiscover is specified, Add-Device will perform an Automatic auto-discovery.</maml:para> <maml:para>For more advanced scenarios where you wish to specify more advanced parameters (such as the Internet Protocol version used to communicate with the device) a NewDeviceParameters object can instead be created with the New-DeviceParameters cmdlet. When the parameters object is passed to Add-Device, PrtgAPI will validate that all mandatory parameter fields contain values. If a mandatory field is missing a value, Add-Sensor will throw an InvalidOperationException, listing the field whose value was missing.</maml:para> <maml:para>By default, Add-Device will attempt to resolve the created device to a Device object. As PRTG does not return the ID of the created object, PrtgAPI identifies the newly created device by comparing the devices under the parent object before and after the new device is created. While this is generally very reliable, in the event something or someone else creates another new device directly under the target object with the same Name, that object will also be returned in the objects resolved by Add-Device. If you do not wish to resolve the created device, this behavior can be disabled by specifying -Resolve:$false.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: DefaultSet --> <command:syntaxItem> <maml:name>Add-Device</maml:name> <!-- Parameter: Parameters --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>Parameters</maml:name> <maml:description> <maml:para>A set of parameters whose properties describe the type of object to add, with what settings.</maml:para> </maml:description> <command:parameterValue required="true">NewDeviceParameters</command:parameterValue> <dev:type> <maml:name>PrtgAPI.Parameters.NewDeviceParameters</maml:name> <maml:uri /> <maml:description> <maml:para>Represents parameters used to construct a PrtgUrl for adding new Device objects.</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: Destination --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Destination</maml:name> <maml:description> <maml:para>The parent object to create an object under.</maml:para> </maml:description> <command:parameterValue required="true">GroupOrProbe</command:parameterValue> <dev:type> <maml:name>PrtgAPI.Objects.Shared.GroupOrProbe</maml:name> <maml:uri /> <maml:description> <maml:para>Base class for Groups and Probes, containing properties that apply to both object types.</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: Destination --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Destination</maml:name> <maml:description> <maml:para>The parent object to create an object under.</maml:para> </maml:description> <command:parameterValue required="true">GroupOrProbe</command:parameterValue> <dev:type> <maml:name>PrtgAPI.Objects.Shared.GroupOrProbe</maml:name> <maml:uri /> <maml:description> <maml:para>Base class for Groups and Probes, containing properties that apply to both object types.</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 new object should be resolved to a PrtgObject. By default this value is Present.</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> <!-- Parameter set: BasicSet --> <command:syntaxItem> <maml:name>Add-Device</maml:name> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name to use for the device. If a Host is not specified, this value will be used as the hostname as well.</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: Host --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Host</maml:name> <maml:description> <maml:para>The IPv4 Address/HostName to use for monitoring this device. If this value is not specified, the Name will be used as the hostname.</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: Destination --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Destination</maml:name> <maml:description> <maml:para>The parent object to create an object under.</maml:para> </maml:description> <command:parameterValue required="true">GroupOrProbe</command:parameterValue> <dev:type> <maml:name>PrtgAPI.Objects.Shared.GroupOrProbe</maml:name> <maml:uri /> <maml:description> <maml:para>Base class for Groups and Probes, containing properties that apply to both object types.</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: AutoDiscover --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AutoDiscover</maml:name> <maml:description> <maml:para>Whether to perform an Automatic auto-discovery on the newly created device.</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: 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 new object should be resolved to a PrtgObject. By default this value is Present.</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: Destination --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Destination</maml:name> <maml:description> <maml:para>The parent object to create an object under.</maml:para> </maml:description> <command:parameterValue required="true">GroupOrProbe</command:parameterValue> <dev:type> <maml:name>PrtgAPI.Objects.Shared.GroupOrProbe</maml:name> <maml:uri /> <maml:description> <maml:para>Base class for Groups and Probes, containing properties that apply to both object types.</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 name to use for the device. If a Host is not specified, this value will be used as the hostname as well.</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: Host --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Host</maml:name> <maml:description> <maml:para>The IPv4 Address/HostName to use for monitoring this device. If this value is not specified, the Name will be used as the hostname.</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: AutoDiscover --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AutoDiscover</maml:name> <maml:description> <maml:para>Whether to perform an Automatic auto-discovery on the newly created device.</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: Destination --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Destination</maml:name> <maml:description> <maml:para>The parent object to create an object under.</maml:para> </maml:description> <command:parameterValue required="true">GroupOrProbe</command:parameterValue> <dev:type> <maml:name>PrtgAPI.Objects.Shared.GroupOrProbe</maml:name> <maml:uri /> <maml:description> <maml:para>Base class for Groups and Probes, containing properties that apply to both object types.</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: Parameters --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>Parameters</maml:name> <maml:description> <maml:para>A set of parameters whose properties describe the type of object to add, with what settings.</maml:para> </maml:description> <command:parameterValue required="true">NewDeviceParameters</command:parameterValue> <dev:type> <maml:name>PrtgAPI.Parameters.NewDeviceParameters</maml:name> <maml:uri /> <maml:description> <maml:para>Represents parameters used to construct a PrtgUrl for adding new Device objects.</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 new object should be resolved to a PrtgObject. By default this value is Present.</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.Objects.Shared.GroupOrProbe</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The parent object to create an object under.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>PrtgAPI.Objects.Shared.GroupOrProbe</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The parent object to create an object under.</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 contoso | Add-Device dc-1</dev:code> <dev:remarks> <maml:para>Add a new device named "dc-1" to the Contoso probe, using "dc-1" as its hostname, without performing an automatic auto-discovery.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>C:\> Get-Group -Id 2305 | Add-Device exch-1 192.168.0.2 -AutoDiscover</dev:code> <dev:remarks> <maml:para>Add a device named "exch-1" to the group with ID 2305, using 192.168.0.2 as its IP Address and performing an automatic auto-discovery after the device is created.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 3 ----------</maml:title> <dev:code>C:\> $params = New-DeviceParameters sql-1 "2001:db8::ff00:42:8329"</dev:code> <dev:remarks> <maml:para>C:\> $params.IPVersion = "IPv6"</maml:para> <maml:para>C:\> Get-Probe contoso | Add-Device $params</maml:para> <maml:para>Add a device named sql-1 using an IPv6 Address to the probe Contoso probe.</maml:para> </dev:remarks> </command:example> </command:examples> </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>Get-Device provides two parameter sets for filtering objects by tags. When filtering for devices that contain one of several tags, the -Tag parameter can be used, performing a logical OR between all specified operands. For scenarios in which you wish to filter for devices containing ALL specified tags, the -Tags parameter can be used, performing a logical AND between all specified operands.</maml:para> <maml:para>When requesting devices belonging to a specified group, PRTG will not return any objects that may be present under further child groups of the parent group. To work around this, by default Get-Device will automatically recurse child groups if it detects the initial device request did not return all items (as evidenced by the parent group's TotalDevices property. If you do not wish Get-Device to recurse child groups, this behavior can be overridden by specifying -Recurse:$false.</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: Tags --> <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">int[]</command:parameterValue> <dev:type> <maml:name>System.Int32[]</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: Recurse --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Recurse</maml:name> <maml:description> <maml:para>When piping from a Group, specifies that PrtgAPI should also recursively traverse all subgroups until all objects that should be returned by this cmdlet have been found. By default this value is true. If this value is false, PrtgAPI will not return objects from under any subgroups of the target group.</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> <!-- 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 all specified 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> <!-- Parameter set: Tag --> <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">int[]</command:parameterValue> <dev:type> <maml:name>System.Int32[]</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: Recurse --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Recurse</maml:name> <maml:description> <maml:para>When piping from a Group, specifies that PrtgAPI should also recursively traverse all subgroups until all objects that should be returned by this cmdlet have been found. By default this value is true. If this value is false, PrtgAPI will not return objects from under any subgroups of the target group.</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> <!-- 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: Tag --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Tag</maml:name> <maml:description> <maml:para>Filter the response to objects with one of several 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: Recurse --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Recurse</maml:name> <maml:description> <maml:para>When piping from a Group, specifies that PrtgAPI should also recursively traverse all subgroups until all objects that should be returned by this cmdlet have been found. By default this value is true. If this value is false, PrtgAPI will not return objects from under any subgroups of the target group.</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> <!-- 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: 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">int[]</command:parameterValue> <dev:type> <maml:name>System.Int32[]</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 all specified 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: Tag --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Tag</maml:name> <maml:description> <maml:para>Filter the response to objects with one of several 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: 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> </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.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: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: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 -Tag C_OS_Win,exch</dev:code> <dev:remarks> <maml:para>Get all devices that have the tag "C_OS_Win" or "exch"</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 6 ----------</maml:title> <dev:code>C:\> Get-Device -Tags ny,C_OS_Win</dev:code> <dev:remarks> <maml:para>Get all Windows servers in New York</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 7 ----------</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 8 ----------</maml:title> <dev:code>C:\> flt location contains "new york" | Get-Device</dev:code> <dev:remarks> <maml:para>Get all devices whose location contains "new york"</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 9 ----------</maml:title> <dev:code>C:\> Get-Group -Id 2001 | Get-Device -Recurse:$false</dev:code> <dev:remarks> <maml:para>Get all devices directly under the specified group, ignoring all child groups.</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:navigationLink> <maml:linkText>New-SearchFilter</maml:linkText> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: New-DeviceParameters --> <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-DeviceParameters</command:name> <command:verb>New</command:verb> <command:noun>DeviceParameters</command:noun> <maml:description> <maml:para>Creates a new set of device parameters for creating a brand new device under a group or probe.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The New-DeviceParameters cmdlet creates a set of parameters for adding a brand new device to PRTG. Device parameter objects returned from New-DeviceParameters allow specifying a variety of device specific configuration details including Internet Protocol version and auto-discovery settings at the time of object creation.</maml:para> <maml:para>All devices must have a Name and Host property specified. If a Host (IP Address/HostName) is not specified in the call to New-DeviceParameters, PrtgAPI will automatically use the Name</maml:para> <maml:para>Note that not all device parameters (such as settings that can be inherited from the parent group) can be specified with PrtgAPI at the time of object creation. If you wish to modify such properties, this can be achieved after the device has been created via the Set-ObjectProperty cmdlet.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>New-DeviceParameters</maml:name> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name to give the new 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: Host --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Host</maml:name> <maml:description> <maml:para>The hostname or IP Address to use for the new device. If no value is specified, the name will be used.</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="true" globbing="false" pipelineInput="false" position="0"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name to give the new 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: Host --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Host</maml:name> <maml:description> <maml:para>The hostname or IP Address to use for the new device. If no value is specified, the name will be used.</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 /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>C:\> $params = New-DeviceParameters dc-1</dev:code> <dev:remarks> <maml:para>C:\> Get-Probe contoso | Add-Device $params</maml:para> <maml:para>Create a new device named "dc-1" with hostname "dc-1" under the Contoso probe.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>C:\> $params = New-DeviceParameters exch-1 "2001:db8::ff00:42:8329"</dev:code> <dev:remarks> <maml:para>C:\> $params.IPVersion = "IPv6"</maml:para> <maml:para>C:\> Get-Probe contoso | Add-Device $params</maml:para> <maml:para>Create a new device named "dc-2" with an IPv6 address, specifying the Internet Protocol as IPv6.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 3 ----------</maml:title> <dev:code>C:\> $params = New-DeviceParameters dc-1</dev:code> <dev:remarks> <maml:para>C:\> Get-Probe contoso | Add-Device $params -PassThru | Set-ObjectProperty Location "23 Fleet Street"</maml:para> <maml:para>Create a new device named "dc-1" and then set its location.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Add-Device</maml:linkText> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-ObjectProperty</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:para>By default, Simulate-ErrorStatus will operate in Batch Mode. In Batch Mode, Simulate-ErrorStatus will not execute a request for each individual object, but will rather store each item in a queue to simulate errors for all objects at once, via a single request. This allows PrtgAPI to be extremely performant in performing operations against a large number of objects.</maml:para> <maml:para>If the pipeline is cancelled (either due to a cmdlet throwing an exception or the user pressing Ctrl-C) before fully completing, Simulate-ErrorStatus will not generate a request against PRTG. If you wish to disable Batch Mode and fully process objects individually one at a time, this can be achieved by specifying -Batch:$false.</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> <!-- Parameter: Batch --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Batch</maml:name> <maml:description> <maml:para>Specifies whether this cmdlet should queue all objects piped to this cmdlet to execute a single request against PRTG for processing all objects. By default this value is true.</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> <!-- Parameter: PassThru --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PassThru</maml:name> <maml:description> <maml:para>Specifies whether to return the original PrtgObject that was passed to this cmdlet, allowing the object to be further piped into additional cmdlets.</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: 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> <!-- Parameter: Batch --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Batch</maml:name> <maml:description> <maml:para>Specifies whether this cmdlet should queue all objects piped to this cmdlet to execute a single request against PRTG for processing all objects. By default this value is true.</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> <!-- Parameter: PassThru --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PassThru</maml:name> <maml:description> <maml:para>Specifies whether to return the original PrtgObject that was passed to this cmdlet, allowing the object to be further piped into additional cmdlets.</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 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: Add-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>Add-Group</command:name> <command:verb>Add</command:verb> <command:noun>Group</command:noun> <maml:description> <maml:para>Adds a new group to a PRTG Group or Probe.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Add-Group cmdlet adds a new group to a a PRTG Group or Probe. When adding a new group, Add-Group supports two methods of specifying the parameters required to create the object. For basic scenarios where you inherit all settings from the parent object, a group can created by passing nothing more than a Name to Add-Group.</maml:para> <maml:para>For more advanced scenarios where you wish to specify more advanced parameters (such as Tags that will apply to the group) a NewGroupParameters object can be instead created with the New-GroupParameters cmdlet. When the parameters object is passed to Add-Device, PrtgAPI will validate that all mandatory parameter fields contain values. If a mandatory field is missing a value, Add-Sensor will throw an InvalidOperationException, listing the field whose value was missing.</maml:para> <maml:para>By default, Add-Group will attempt to resolve the created group to a Group object. As PRTG does not return the ID of the created object, PrtgAPI identifies the newly created group by comparing the groups under the parent object before and after the new group is created. While this is generally very reliable, in the event something or someone else creates another new group directly under the target object with the same Name, that object will also be returned in the objects resolved by Add-Group. If you do not wish to resolve the created group, this behavior can be disabled by specifying -Resolve:$false.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: DefaultSet --> <command:syntaxItem> <maml:name>Add-Group</maml:name> <!-- Parameter: Parameters --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>Parameters</maml:name> <maml:description> <maml:para>A set of parameters whose properties describe the type of object to add, with what settings.</maml:para> </maml:description> <command:parameterValue required="true">NewGroupParameters</command:parameterValue> <dev:type> <maml:name>PrtgAPI.Parameters.NewGroupParameters</maml:name> <maml:uri /> <maml:description> <maml:para>Represents parameters used to construct a PrtgUrl for adding new Group objects.</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: Destination --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Destination</maml:name> <maml:description> <maml:para>The parent object to create an object under.</maml:para> </maml:description> <command:parameterValue required="true">GroupOrProbe</command:parameterValue> <dev:type> <maml:name>PrtgAPI.Objects.Shared.GroupOrProbe</maml:name> <maml:uri /> <maml:description> <maml:para>Base class for Groups and Probes, containing properties that apply to both object types.</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: Destination --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Destination</maml:name> <maml:description> <maml:para>The parent object to create an object under.</maml:para> </maml:description> <command:parameterValue required="true">GroupOrProbe</command:parameterValue> <dev:type> <maml:name>PrtgAPI.Objects.Shared.GroupOrProbe</maml:name> <maml:uri /> <maml:description> <maml:para>Base class for Groups and Probes, containing properties that apply to both object types.</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 new object should be resolved to a PrtgObject. By default this value is Present.</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> <!-- Parameter set: BasicSet --> <command:syntaxItem> <maml:name>Add-Group</maml:name> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name to use for the group.</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: Destination --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Destination</maml:name> <maml:description> <maml:para>The parent object to create an object under.</maml:para> </maml:description> <command:parameterValue required="true">GroupOrProbe</command:parameterValue> <dev:type> <maml:name>PrtgAPI.Objects.Shared.GroupOrProbe</maml:name> <maml:uri /> <maml:description> <maml:para>Base class for Groups and Probes, containing properties that apply to both object types.</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 new object should be resolved to a PrtgObject. By default this value is Present.</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: Destination --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Destination</maml:name> <maml:description> <maml:para>The parent object to create an object under.</maml:para> </maml:description> <command:parameterValue required="true">GroupOrProbe</command:parameterValue> <dev:type> <maml:name>PrtgAPI.Objects.Shared.GroupOrProbe</maml:name> <maml:uri /> <maml:description> <maml:para>Base class for Groups and Probes, containing properties that apply to both object types.</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 name to use for the group.</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: Destination --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Destination</maml:name> <maml:description> <maml:para>The parent object to create an object under.</maml:para> </maml:description> <command:parameterValue required="true">GroupOrProbe</command:parameterValue> <dev:type> <maml:name>PrtgAPI.Objects.Shared.GroupOrProbe</maml:name> <maml:uri /> <maml:description> <maml:para>Base class for Groups and Probes, containing properties that apply to both object types.</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: Parameters --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>Parameters</maml:name> <maml:description> <maml:para>A set of parameters whose properties describe the type of object to add, with what settings.</maml:para> </maml:description> <command:parameterValue required="true">NewGroupParameters</command:parameterValue> <dev:type> <maml:name>PrtgAPI.Parameters.NewGroupParameters</maml:name> <maml:uri /> <maml:description> <maml:para>Represents parameters used to construct a PrtgUrl for adding new Group objects.</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 new object should be resolved to a PrtgObject. By default this value is Present.</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.Objects.Shared.GroupOrProbe</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The parent object to create an object under.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>PrtgAPI.Objects.Shared.GroupOrProbe</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The parent object to create an object under.</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 contoso | Add-Group Servers</dev:code> <dev:remarks> <maml:para>Add a new group called "Servers" to the Contoso probe.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>C:\> $params = New-GroupParameters Servers</dev:code> <dev:remarks> <maml:para>C:\> $params.Tags = "awesomeGroup"</maml:para> <maml:para>C:\> Get-Probe contoso | Add-Device $params</maml:para> <maml:para>Add a new group called "Servers" with custom tags to the Contoso probe.</maml:para> </dev:remarks> </command:example> </command:examples> </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>Get-Group provides two parameter sets for filtering objects by tags. When filtering for groups that contain one of several tags, the -Tag parameter can be used, performing a logical OR between all specified operands. For scenarios in which you wish to filter for groups containing ALL specified tags, the -Tags parameter can be used, performing a logical AND between all specified operands.</maml:para> <maml:para>When requesting groups belonging to a specified group, PRTG will not return any objects that may be present under further child groups of the parent group (i.e. grandchildren). To work around this, by default Get-Groups will automatically recurse child groups if it detects the initial group request did not return all items (as evidenced by the group's TotalGroups property. If you do not wish Get-Group to recurse child groups, this behavior can be overridden by specifying -Recurse:$false.</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: Tags --> <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">int[]</command:parameterValue> <dev:type> <maml:name>System.Int32[]</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: Recurse --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Recurse</maml:name> <maml:description> <maml:para>When piping from a Group, specifies that PrtgAPI should also recursively traverse all subgroups until all objects that should be returned by this cmdlet have been found. By default this value is true. If this value is false, PrtgAPI will not return objects from under any subgroups of the target group.</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> <!-- 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 all specified 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> <!-- Parameter set: Tag --> <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">int[]</command:parameterValue> <dev:type> <maml:name>System.Int32[]</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: Recurse --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Recurse</maml:name> <maml:description> <maml:para>When piping from a Group, specifies that PrtgAPI should also recursively traverse all subgroups until all objects that should be returned by this cmdlet have been found. By default this value is true. If this value is false, PrtgAPI will not return objects from under any subgroups of the target group.</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> <!-- 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: Tag --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Tag</maml:name> <maml:description> <maml:para>Filter the response to objects with one of several 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: Recurse --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Recurse</maml:name> <maml:description> <maml:para>When piping from a Group, specifies that PrtgAPI should also recursively traverse all subgroups until all objects that should be returned by this cmdlet have been found. By default this value is true. If this value is false, PrtgAPI will not return objects from under any subgroups of the target group.</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> <!-- 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: 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">int[]</command:parameterValue> <dev:type> <maml:name>System.Int32[]</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 all specified 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: Tag --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Tag</maml:name> <maml:description> <maml:para>Filter the response to objects with one of several 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: 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> </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.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: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: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:example> <maml:title>---------- EXAMPLE 6 ----------</maml:title> <dev:code>C:\> Get-Group -Id 2001 | Get-Group -Recurse:$false</dev:code> <dev:remarks> <maml:para>Get all groups directly under the specified group, ignoring all grandchildren.</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: New-GroupParameters --> <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-GroupParameters</command:name> <command:verb>New</command:verb> <command:noun>GroupParameters</command:noun> <maml:description> <maml:para>Creates a new set of group parameters for creating a brand new group under a group or probe.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The New-GroupParameters cmdlet creates a set of parameters for adding a brand new group to PRTG. Group parameter objects returned from New-GroupParameters allow specifying a variety of group specific configuration details including auto-discovery settings at the time of object creation.</maml:para> <maml:para>Note that not all group parameters (such as settings that can be inherited from the parent group or probe) can be specified with PrtgAPI at the time of object creation. If you wish to modify such properties, this can be achieved after the group has been created via the Set-ObjectProperty cmdlet.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>New-GroupParameters</maml:name> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name to give the new group.</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="true" globbing="false" pipelineInput="false" position="0"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name to give the new group.</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 /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>C:\> $params = New-GroupParameters Servers</dev:code> <dev:remarks> <maml:para>C:\> Get-Probe contoso | Add-Group $params</maml:para> <maml:para>Add a new group called "Servers" to the Contoso probe.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>C:\> $params = New-GroupParameters Servers</dev:code> <dev:remarks> <maml:para>C:\> $params.Tags = "awesomeGroup"</maml:para> <maml:para>C:\> Get-Probe Contoso | Add-Group $params</maml:para> <maml:para>Add a new group called "Servers" to the Contoso probe with a custom tag "awesomeGroup".</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Add-Group</maml:linkText> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-ObjectProperty</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: DefaultSet --> <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>Base class for Sensors, Devices, Groups and Probes, containing properties that apply to all four object types.</maml:para> </maml:description> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: ManualSet --> <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>Base class for Sensors, Devices, Groups and Probes, containing properties that apply to all four object types.</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:para>Get-NotificationAction supports filtering returned actions by a number of parameters, including by -Name, -Id, -Tags or a custom SearchFilter. When filtering by tags, the -Tag parameter can be used, performing a logical OR between all specified operands. For scenarios in which you wish to filter for devices containing ALL specified tags, the -Tags parameter can be used, performing a logical AND between all specified operands.</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:para>Get-Device provides two parameter sets for filtering objects by tags. When filtering for devices that contain one of several tags, the -Tag parameter can be used, performing a logical OR between all specified operands. For scenarios in which you wish to filter for devices containing ALL specified tags, the -Tags parameter can be used, performing a logical AND between all specified operands.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: Tags --> <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> <!-- 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">int[]</command:parameterValue> <dev:type> <maml:name>System.Int32[]</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 all specified 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> <!-- Parameter set: Tag --> <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> <!-- 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">int[]</command:parameterValue> <dev:type> <maml:name>System.Int32[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Tag --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Tag</maml:name> <maml:description> <maml:para>Filter the response to objects with one of several 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: 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">int[]</command:parameterValue> <dev:type> <maml:name>System.Int32[]</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 all specified 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: Tag --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Tag</maml:name> <maml:description> <maml:para>Filter the response to objects with one of several 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: 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> </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:inputTypes> <command:returnValues> <!-- OutputType: NotificationAction --> <command:returnValue> <dev:type> <maml:name>PrtgAPI.NotificationAction</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>An action to be performed by PRTG when a NotificationTrigger activates.</maml:para> </maml:description> </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:example> <maml:title>---------- EXAMPLE 3 ----------</maml:title> <dev:code>C:\> Get-NotificationTrigger -Id 301,302</dev:code> <dev:remarks> <maml:para>Get the notification actions with IDs 301 and 302.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 4 ----------</maml:title> <dev:code>C:\> Get-NotificationTrigger -Tags PagerDuty</dev:code> <dev:remarks> <maml:para>Get all notification actions tagged with "PagerDuty"</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> </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).</maml:para> <maml:para>Attempting to add a notification trigger to an object that does not supported that trigger 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>By default, Add-NotificationTrigger will attempt to resolve the created trigger to a NotificationTrigger object. As PRTG does not return the ID of the created object, PrtgAPI identifies the newly created trigger by comparing the triggers on the parent object before and after the new trigger is created. While this is generally very reliable, in the event something or someone else creates another new trigger directly under the target object with the same OnNotificationAction, that object will also be returned in the objects resolved by Add-NotificationTrigger. If you do not wish to resolve the created trigger, this behavior can be disabled by specifying -Resolve:$false.</maml:para> <maml:para>For more information on creating TriggerParameters , see New-NotificationTriggerParameters.</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 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 used to construct a PrtgUrl for adding/modifying NotificationTrigger objects.</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 new object should be resolved to a PrtgObject. By default this value is Present.</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: 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 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 used to construct a PrtgUrl for adding/modifying NotificationTrigger objects.</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 new object should be resolved to a PrtgObject. By default this value is Present.</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.Parameters.TriggerParameters</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The parameters to use to add 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-TriggerParameters 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-NotificationTriggerParameters</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-NotificationTriggerParameters, 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: DefaultSet --> <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>Base class for Sensors, Devices, Groups and Probes, containing properties that apply to all four object types.</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: TypeSet --> <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>Base class for Sensors, Devices, Groups and Probes, containing properties that apply to all four object types.</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>Base class for Sensors, Devices, Groups and Probes, containing properties that apply to all four object types.</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-NotificationTriggerParameters</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>Modifies 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-NotificationTriggerParameters</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 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 used 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 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 used 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 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-TriggerParameters</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-NotificationTriggerParameters</maml:linkText> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Edit-NotificationTriggerProperty</maml:linkText> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: New-NotificationTriggerParameters --> <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-NotificationTriggerParameters</command:name> <command:verb>New</command:verb> <command:noun>NotificationTriggerParameters</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-NotificationTriggerParameters cmdlet creates a set of trigger parameters for creating or editing a notification trigger. When editing notification triggers, New-NotificationTriggerParameters 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-NotificationTriggerParameters 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: AddSet --> <command:syntaxItem> <maml:name>New-NotificationTriggerParameters</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: EditSet --> <command:syntaxItem> <maml:name>New-NotificationTriggerParameters</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: AddFromSet --> <command:syntaxItem> <maml:name>New-NotificationTriggerParameters</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: EditFromSet --> <command:syntaxItem> <maml:name>New-NotificationTriggerParameters</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 used 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:\> $params = New-TriggerParameters 1234 State</dev:code> <dev:remarks> <maml:para>C:\> $params | 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:\> $params = New-TriggerParameters 1234 3 State</dev:code> <dev:remarks> <maml:para>C:\> $params.Latency = 40</maml:para> <maml:para>C:\> $params | 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:\> $params = Get-Sensor -Id 1001 | Get-Trigger -Type State -Inherited $false | New-TriggerParameters 1234</dev:code> <dev:remarks> <maml:para>C:\> $params.OffNotificationAction = $null</maml:para> <maml:para>C:\> $params | 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:\> $params = Get-Sensor -Id 1001 | Get-Trigger -Type State -Inherited $false | New-TriggerParameters</dev:code> <dev:remarks> <maml:para>C:\> $params.Latency = 30</maml:para> <maml:para>C:\> $params | 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:\> $params = New-TriggerParameters $sensor.Id Threshold</maml:para> <maml:para>C:\> $params.Channel = $channel</maml:para> <maml:para>C:\> $params | 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:\> $params = New-TriggerParameters 1001 Threshold</dev:code> <dev:remarks> <maml:para>C:\> $params.Channel = 1</maml:para> <maml:para>C:\> $params | 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> <maml:description> <maml:para>The Edit-NotificationTriggerProperty cmdlet allows a single notification trigger property to be modified. Typically when you wish to modify the properties of an existing notification trigger, a TriggerParameters object must be constructed and then passed to the Set-NotificationTrigger cmdlet. Edit-NotificationTriggerProperty simplifies the common case of only wanting to modify a single property of the trigger.</maml:para> </maml:description> <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> <!-- Parameter: PassThru --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PassThru</maml:name> <maml:description> <maml:para>Specifies whether to return the original PrtgObject that was passed to this cmdlet, allowing the object to be further piped into additional cmdlets.</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 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> <!-- Parameter: PassThru --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PassThru</maml:name> <maml:description> <maml:para>Specifies whether to return the original PrtgObject that was passed to this cmdlet, allowing the object to be further piped into additional cmdlets.</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 edit.</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 1044 | Get-Trigger | Edit-TriggerProperty OnNotificationAction $null</dev:code> <dev:remarks> <maml:para>Remove the OnNotificationAction of all triggers defined on the object with ID 1044</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Get-NotificationTrigger</maml:linkText> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-NotificationTrigger</maml:linkText> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-NotificationTriggerParameters</maml:linkText> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Copy-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>Copy-Object</command:name> <command:verb>Copy</command:verb> <command:noun>Object</command:noun> <maml:description> <maml:para>Clones a sensor, device, group or notification trigger within PRTG.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Clone-Object cmdlet duplicates a PRTG Sensor, Device, Group or Notification Trigger, including all objects defined under it (such as all sensors of a device, or all devices and sensors of a group).</maml:para> <maml:para>Clone-Object can operate in two modes: Clone From and Clone To. In Clone From mode (the default) objects you wish to clone are piped into Clone-Object, requiring you to specify the Object ID of the parent the cloned object will sit under. In Clone To mode, objects you wish to clone a single object to are piped to Clone-Object, requiring you to specify the ID of the object you wish to clone.</maml:para> <maml:para>Sensors can only be cloned to Device objects, whereas devices and groups can both cloned to other groups or directly under a probe.</maml:para> <maml:para>When cloning sensors, devices and groups objects (in Clone From mode), a name can optionally be specified. When cloning sensors and groups, if a name is not specified the name of the original sensor or group will be used. When cloning devices, if a name is not specified PrtgAPI will automatically name the device as "Clone of <device>, where <device> is the name of the original device. When cloning devices, a Hostname/IP Address can optionally be specified. If a Hostname/IP Address is ommitted, PrtgAPI will use the name of the device as the hostname. Cloning a notification trigger with Clone-Object is equivalent to passing a trigger to the New-TriggerParameters cmdlet, followed by Add-NotificationTrigger.</maml:para> <maml:para>To clone a single child object to multiple destination objects, the -SourceId parameter can be specified. When operating in Clone To mode, Clone-Object will automatically assign the newly created object the same name as the source object. When Clone-Object executes, it will automatically attempt to resolve the target object specified by the -SourceId parameter. If -SourceId cannot be resolved to a valid sensor, device or group, Clone-Object will throw an exception specifying that the specified object ID is not valid.</maml:para> <maml:para>When an object has been cloned, by default Clone-Object will attempt to automatically resolve the object into its resultant Sensor, Device, Group or NotificationTrigger object. 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-Object cannot resolve the resultant object on the first attempt, PrtgAPI will make a further 4 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-Object to output a clone summary, including the object ID, name and hostname (for devices) of the new object. When cloning triggers, is -Resolve:$false is specified, no summary will be returned (as PRTG does not automatically return any information regarding cloned triggers). As PRTG pauses all cloned sensors, devices and groups 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: SensorToDestination --> <command:syntaxItem> <maml:name>Copy-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 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 new object should be resolved to a PrtgObject. By default this value is Present.</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> <!-- Parameter set: DeviceToDestination --> <command:syntaxItem> <maml:name>Copy-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 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: Host --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>Host</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 new object should be resolved to a PrtgObject. By default this value is Present.</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> <!-- Parameter set: GroupToDestination --> <command:syntaxItem> <maml:name>Copy-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 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 new object should be resolved to a PrtgObject. By default this value is Present.</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> <!-- Parameter set: TriggerToDestination --> <command:syntaxItem> <maml:name>Copy-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 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: Trigger --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Trigger</maml:name> <maml:description> <maml:para>The notification trigger to clone.</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: 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 new object should be resolved to a PrtgObject. By default this value is Present.</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> <!-- Parameter set: TargetForSource --> <command:syntaxItem> <maml:name>Copy-Object</maml:name> <!-- Parameter: Destination --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Destination</maml:name> <maml:description> <maml:para>The object to clone the object specified by the SourceId to.</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>Base class for Devices, Groups and Probes, containing properties that apply to all three object types.</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: SourceId --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>SourceId</maml:name> <maml:description> <maml:para>The ID of the object to clone.</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: 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 new object should be resolved to a PrtgObject. By default this value is Present.</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: 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: Host --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>Host</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: 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: 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: 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: Trigger --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Trigger</maml:name> <maml:description> <maml:para>The notification trigger to clone.</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: SourceId --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>SourceId</maml:name> <maml:description> <maml:para>The ID of the object to clone.</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: Destination --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Destination</maml:name> <maml:description> <maml:para>The object to clone the object specified by the SourceId to.</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>Base class for Devices, Groups and Probes, containing properties that apply to all three object types.</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 new object should be resolved to a PrtgObject. By default this value is Present.</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: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: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:inputType> <dev:type> <maml:name>PrtgAPI.NotificationTrigger</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The notification trigger to clone.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>PrtgAPI.Objects.Shared.DeviceOrGroupOrProbe</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The object to clone the object specified by the SourceId to.</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 1234 | Clone-Object 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-Object 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-Device *exch* | Clone-Object -SourceId 2002</dev:code> <dev:remarks> <maml:para>Clone the object with ID 2002 to all devices whose name contains "exch"</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 4 ----------</maml:title> <dev:code>C:\> Get-Sensor -Id 1234 | Clone-Object 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> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 5 ----------</maml:title> <dev:code>C:\> Get-Device -Id 1234 | Clone-Object 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 6 ----------</maml:title> <dev:code>C:\> Get-Probe -Id 1234 | Get-Trigger | Clone-Object 5678</dev:code> <dev:remarks> <maml:para>Clone all notification triggers (both inherited and explicitly defined) on the probe with ID 1234 to the object with ID 5678</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-Trigger</maml:linkText> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-NotificationTriggerParameters</maml:linkText> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Add-NotificationTrigger</maml:linkText> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Resume-Object</maml:linkText> </maml:navigationLink> </maml:relatedLinks> </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> <maml:description> <maml:para>The Move-Object cmdlet allows you to move a device or group to another group or probe within PRTG. Any device or group can be moved to any other group or probe, with the exception of special objects such as the "Probe Device" object under each probe, as well as the Root group (ID: 0).</maml:para> </maml:description> <command:syntax> <!-- Parameter set: DeviceSet --> <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> <!-- Parameter: PassThru --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PassThru</maml:name> <maml:description> <maml:para>Specifies whether to return the original PrtgObject that was passed to this cmdlet, allowing the object to be further piped into additional cmdlets.</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> <!-- Parameter set: GroupSet --> <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> <!-- Parameter: PassThru --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PassThru</maml:name> <maml:description> <maml:para>Specifies whether to return the original PrtgObject that was passed to this cmdlet, allowing the object to be further piped into additional cmdlets.</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: 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> <!-- Parameter: PassThru --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PassThru</maml:name> <maml:description> <maml:para>Specifies whether to return the original PrtgObject that was passed to this cmdlet, allowing the object to be further piped into additional cmdlets.</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.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:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>Get-Device dc-1 | Move-Object 5678</dev:code> <dev:remarks> <maml:para>Move all devices named dc-1 to under the object with ID 5678</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:relatedLinks> </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>Remove-Object is capable of operating in Batch Mode. In Batch Mode, Remove-Object will not execute a request for each individual object, but will rather store each item in a queue to remove all objects at once, via a single request. This allows PrtgAPI to be extremely performant in performing operations against a large number of objects. Due to the inherent danger in batch removing multiple objects so quickly, Remove-Object will only operate in Batch mode if -Batch is specified. If Remove-Object is invoked with -Force, -Batch mode will be automatically enabled unless specified otherwise.</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>Base class for Sensors, Devices, Groups and Probes, containing properties that apply to all four object types.</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: Batch --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Batch</maml:name> <maml:description> <maml:para>Specifies whether this cmdlet should queue all objects piped to this cmdlet to execute a single request against PRTG for processing all objects. By default this value is true.</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: 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> <!-- Parameter: PassThru --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PassThru</maml:name> <maml:description> <maml:para>Specifies whether to return the original PrtgObject that was passed to this cmdlet, allowing the object to be further piped into additional cmdlets.</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>Base class for Sensors, Devices, Groups and Probes, containing properties that apply to all four object types.</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> <!-- Parameter: Batch --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Batch</maml:name> <maml:description> <maml:para>Specifies whether this cmdlet should queue all objects piped to this cmdlet to execute a single request against PRTG for processing all objects. By default this value is true.</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: PassThru --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PassThru</maml:name> <maml:description> <maml:para>Specifies whether to return the original PrtgObject that was passed to this cmdlet, allowing the object to be further piped into additional cmdlets.</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> <maml:description> <maml:para>The Rename-Object cmdlet allows you to rename a Sensor, Device, Group or Probe within PRTG. When renaming objects, it is recommended to first execute Rename-Object first with the -WhatIf parameter. This will show you all the objects that will be renamed when you execute the command normally.</maml:para> <maml:para>By default, Rename-Object will operate in Batch Mode. In Batch Mode, Rename-Object will not execute a request for each individual object, but will rather store each item in a queue to rename all objects at once, via a single request. This allows PrtgAPI to be extremely performant in performing operations against a large number of objects.</maml:para> <maml:para>If the pipeline is cancelled (either due to a cmdlet throwing an exception or the user pressing Ctrl-C) before fully completing, Rename-Object will not generate a request against PRTG. If you wish to disable Batch Mode and fully process objects individually one at a time, this can be achieved by specifying -Batch:$false.</maml:para> </maml:description> <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>Base class for Sensors, Devices, Groups and Probes, containing properties that apply to all four object types.</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: Batch --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Batch</maml:name> <maml:description> <maml:para>Specifies whether this cmdlet should queue all objects piped to this cmdlet to execute a single request against PRTG for processing all objects. By default this value is true.</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> <!-- Parameter: PassThru --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PassThru</maml:name> <maml:description> <maml:para>Specifies whether to return the original PrtgObject that was passed to this cmdlet, allowing the object to be further piped into additional cmdlets.</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 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>Base class for Sensors, Devices, Groups and Probes, containing properties that apply to all four object types.</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> <!-- Parameter: Batch --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Batch</maml:name> <maml:description> <maml:para>Specifies whether this cmdlet should queue all objects piped to this cmdlet to execute a single request against PRTG for processing all objects. By default this value is true.</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> <!-- Parameter: PassThru --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PassThru</maml:name> <maml:description> <maml:para>Specifies whether to return the original PrtgObject that was passed to this cmdlet, allowing the object to be further piped into additional cmdlets.</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 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 a PRTG 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 stopped due to manually pausing or simulating an error state on the object.</maml:para> <maml:para>By default, Resume-Object will operate in Batch Mode. In Batch Mode, Resume-Object will not execute a request for each individual object, but will rather store each item in a queue to resume all objects at once, via a single request. This allows PrtgAPI to be extremely performant in performing operations against a large number of objects.</maml:para> <maml:para>If the pipeline is cancelled (either due to a cmdlet throwing an exception or the user pressing Ctrl-C) before fully completing, Resume-Object will not generate a request against PRTG. If you wish to disable Batch Mode and fully process objects individually one at a time, this can be achieved by specifying -Batch:$false.</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>Base class for Sensors, Devices, Groups and Probes, containing properties that apply to all four object types.</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: Batch --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Batch</maml:name> <maml:description> <maml:para>Specifies whether this cmdlet should queue all objects piped to this cmdlet to execute a single request against PRTG for processing all objects. By default this value is true.</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> <!-- Parameter: PassThru --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PassThru</maml:name> <maml:description> <maml:para>Specifies whether to return the original PrtgObject that was passed to this cmdlet, allowing the object to be further piped into additional cmdlets.</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 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>Base class for Sensors, Devices, Groups and Probes, containing properties that apply to all four object types.</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: Batch --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Batch</maml:name> <maml:description> <maml:para>Specifies whether this cmdlet should queue all objects piped to this cmdlet to execute a single request against PRTG for processing all objects. By default this value is true.</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> <!-- Parameter: PassThru --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PassThru</maml:name> <maml:description> <maml:para>Specifies whether to return the original PrtgObject that was passed to this cmdlet, allowing the object to be further piped into additional cmdlets.</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 resume.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>Get-Sensor -Status PausedByUser | Resume-Object</dev:code> <dev:remarks> <maml:para>Resume all sensors that have been paused by the user. Note: if parent object has been manually paused, child objects will appear PausedByUser but will not be able to be unpaused.</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: 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 a PRTG 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:para>By default, Pause-Object will operate in Batch Mode. In Batch Mode, Pause-Object will not execute a request for each individual object, but will rather store each item in a queue to pause all objects at once, via a single request. This allows PrtgAPI to be extremely performant in performing operations against a large number of objects.</maml:para> <maml:para>If the pipeline is cancelled (either due to a cmdlet throwing an exception or the user pressing Ctrl-C) before fully completing, Pause-Object will not generate a request against PRTG. If you wish to disable Batch Mode and fully process objects individually one at a time, this can be achieved by specifying -Batch:$false.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: DefaultSet --> <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> <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 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>Base class for Sensors, Devices, Groups and Probes, containing properties that apply to all four object types.</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: Batch --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Batch</maml:name> <maml:description> <maml:para>Specifies whether this cmdlet should queue all objects piped to this cmdlet to execute a single request against PRTG for processing all objects. By default this value is true.</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> <!-- 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: PassThru --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PassThru</maml:name> <maml:description> <maml:para>Specifies whether to return the original PrtgObject that was passed to this cmdlet, allowing the object to be further piped into additional cmdlets.</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> <!-- Parameter set: UntilSet --> <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>Base class for Sensors, Devices, Groups and Probes, containing properties that apply to all four object types.</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> <dev:defaultValue>1/1/0001 12:00:00 AM</dev:defaultValue> </command:parameter> <!-- Parameter: Batch --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Batch</maml:name> <maml:description> <maml:para>Specifies whether this cmdlet should queue all objects piped to this cmdlet to execute a single request against PRTG for processing all objects. By default this value is true.</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> <!-- 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: PassThru --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PassThru</maml:name> <maml:description> <maml:para>Specifies whether to return the original PrtgObject that was passed to this cmdlet, allowing the object to be further piped into additional cmdlets.</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> <!-- Parameter set: ForeverSet --> <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>Base class for Sensors, Devices, Groups and Probes, containing properties that apply to all four object types.</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: Batch --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Batch</maml:name> <maml:description> <maml:para>Specifies whether this cmdlet should queue all objects piped to this cmdlet to execute a single request against PRTG for processing all objects. By default this value is true.</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> <!-- 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: PassThru --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PassThru</maml:name> <maml:description> <maml:para>Specifies whether to return the original PrtgObject that was passed to this cmdlet, allowing the object to be further piped into additional cmdlets.</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 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>Base class for Sensors, Devices, Groups and Probes, containing properties that apply to all four object types.</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> <dev:defaultValue>0</dev:defaultValue> </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> <dev:defaultValue>1/1/0001 12:00:00 AM</dev:defaultValue> </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> <!-- Parameter: Batch --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Batch</maml:name> <maml:description> <maml:para>Specifies whether this cmdlet should queue all objects piped to this cmdlet to execute a single request against PRTG for processing all objects. By default this value is true.</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> <!-- Parameter: PassThru --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PassThru</maml:name> <maml:description> <maml:para>Specifies whether to return the original PrtgObject that was passed to this cmdlet, allowing the object to be further piped into additional cmdlets.</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:para>By default, Refresh-Object will operate in Batch Mode. In Batch Mode, Refresh-Object will not execute a request for each individual object, but will rather store each item in a queue to refresh all objects at once, via a single request. This allows PrtgAPI to be extremely performant in performing operations against a large number of objects.</maml:para> <maml:para>If the pipeline is cancelled (either due to a cmdlet throwing an exception or the user pressing Ctrl-C) before fully completing, Refresh-Object will not generate a request against PRTG. If you wish to disable Batch Mode and fully process objects individually one at a time, this can be achieved by specifying -Batch:$false.</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>Base class for Sensors, Devices, Groups and Probes, containing properties that apply to all four object types.</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: Batch --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Batch</maml:name> <maml:description> <maml:para>Specifies whether this cmdlet should queue all objects piped to this cmdlet to execute a single request against PRTG for processing all objects. By default this value is true.</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> <!-- Parameter: PassThru --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PassThru</maml:name> <maml:description> <maml:para>Specifies whether to return the original PrtgObject that was passed to this cmdlet, allowing the object to be further piped into additional cmdlets.</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 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>Base class for Sensors, Devices, Groups and Probes, containing properties that apply to all four object types.</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: Batch --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Batch</maml:name> <maml:description> <maml:para>Specifies whether this cmdlet should queue all objects piped to this cmdlet to execute a single request against PRTG for processing all objects. By default this value is true.</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> <!-- Parameter: PassThru --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PassThru</maml:name> <maml:description> <maml:para>Specifies whether to return the original PrtgObject that was passed to this cmdlet, allowing the object to be further piped into additional cmdlets.</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 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: Get-ObjectLog --> <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-ObjectLog</command:name> <command:verb>Get</command:verb> <command:noun>ObjectLog</command:noun> <maml:description> <maml:para>Retrieves object logs from a PRTG Server.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Get-ObjectLog cmdlet retrieves event logs from a PRTG Server. If no object is specified, Get-ObjectLog will retrieve results from the Root PRTG Group (ID: 0). Logs are ordered from newest to oldest. When retrieving logs from an object, all logs on child objects are also included.</maml:para> <maml:para>If no date range or count is specified, by default Get-ObjectLog will retrieve all logs defined on the specified object for the last 7 days unless the specified object is the root group (ID: 0) or a probe, in which cause only logs that have occurred today will be retrieved.</maml:para> <maml:para>When specifying a date range, well known constants as well as manual start and end times can be specified. When specifying a date and time, Get-ObjectLog considers the "start time" as the time closest to now, while the "end time" is the point in time furthest away from now. If a -StartTime is specified without specifying an -EndTime, Get-ObjectLog will default to retrieving logs for the past 7 days prior to the -StartTime, unless the specified object is the root group (ID: 0) or a probe, in which case Get-ObjectLog will default to retrieving logs for the past 24 hours from the start time. When specifying well known constants, logs are retrieved from the specified point in time until the current time.</maml:para> <maml:para>Logs can be filtered to those of one or more event types by specifying the -Status parameter. Logs can also be filtered according to their event name, however note that name based filtering of Get-ObjectLog is performed client side, not server side. As such, specifying a -Name in conjunction with -Count will not work. This can be cirvumvented using Select-Object with the -First parameter instead.</maml:para> <maml:para>Note that while Get-ObjectLog considers the "start time" as being the point in time closest to now and the "end time" as the point in time furthest away from now, PRTG's underlying API actually defines these in the opposite way. Since logs are ordered from newest to oldest however, PrtgAPI flips these definitions as to prevent any confusion. Keep this in mind in the event the -Verbose parameter is specified, as the start and end times will appear to be switched.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: DateTimeSet --> <command:syntaxItem> <maml:name>Get-ObjectLog</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: EndDate --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>EndDate</maml:name> <maml:description> <maml:para>End time to retrieve logs until. If no value is specified, defaults to 7 prior from the StartDate.</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: Object --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Object</maml:name> <maml:description> <maml:para>Object to retrieve logs for. If no object is specified, defaults to the root object (group ID: 0)</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>Base class for Sensors, Devices, Groups and Probes, containing properties that apply to all four object types.</maml:para> </maml:description> </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 logs from. 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: 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">LogStatus[]</command:parameterValue> <dev:type> <maml:name>PrtgAPI.LogStatus[]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: RecordAgeSet --> <command:syntaxItem> <maml:name>Get-ObjectLog</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: Object --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Object</maml:name> <maml:description> <maml:para>Object to retrieve logs for. If no object is specified, defaults to the root object (group ID: 0)</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>Base class for Sensors, Devices, Groups and Probes, containing properties that apply to all four object types.</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: Since --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Since</maml:name> <maml:description> <maml:para>Time period to retrieve logs from. If no value is specified, retrieves logs from 7 days ago to the current date and time.</maml:para> <maml:para>Possible values: Today, Yesterday, LastWeek, LastMonth, LastSixMonths, LastYear, AllTime</maml:para> </maml:description> <command:parameterValue required="true">RecordAge</command:parameterValue> <dev:type> <maml:name>PrtgAPI.RecordAge</maml:name> <maml:uri /> <maml:description> <maml:para>Specifies time spans for filtering records by.</maml:para> </maml:description> </dev:type> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Today</command:parameterValue> <command:parameterValue required="false" variableLength="false">Yesterday</command:parameterValue> <command:parameterValue required="false" variableLength="false">LastWeek</command:parameterValue> <command:parameterValue required="false" variableLength="false">LastMonth</command:parameterValue> <command:parameterValue required="false" variableLength="false">LastSixMonths</command:parameterValue> <command:parameterValue required="false" variableLength="false">LastYear</command:parameterValue> <command:parameterValue required="false" variableLength="false">AllTime</command:parameterValue> </command:parameterValueGroup> </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">LogStatus[]</command:parameterValue> <dev:type> <maml:name>PrtgAPI.LogStatus[]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Object --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Object</maml:name> <maml:description> <maml:para>Object to retrieve logs for. If no object is specified, defaults to the root object (group ID: 0)</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>Base class for Sensors, Devices, Groups and Probes, containing properties that apply to all four object types.</maml:para> </maml:description> </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 logs from. 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: EndDate --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>EndDate</maml:name> <maml:description> <maml:para>End time to retrieve logs until. If no value is specified, defaults to 7 prior from the StartDate.</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: Since --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Since</maml:name> <maml:description> <maml:para>Time period to retrieve logs from. If no value is specified, retrieves logs from 7 days ago to the current date and time.</maml:para> <maml:para>Possible values: Today, Yesterday, LastWeek, LastMonth, LastSixMonths, LastYear, AllTime</maml:para> </maml:description> <command:parameterValue required="true">RecordAge</command:parameterValue> <dev:type> <maml:name>PrtgAPI.RecordAge</maml:name> <maml:uri /> <maml:description> <maml:para>Specifies time spans for filtering records by.</maml:para> </maml:description> </dev:type> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Today</command:parameterValue> <command:parameterValue required="false" variableLength="false">Yesterday</command:parameterValue> <command:parameterValue required="false" variableLength="false">LastWeek</command:parameterValue> <command:parameterValue required="false" variableLength="false">LastMonth</command:parameterValue> <command:parameterValue required="false" variableLength="false">LastSixMonths</command:parameterValue> <command:parameterValue required="false" variableLength="false">LastYear</command:parameterValue> <command:parameterValue required="false" variableLength="false">AllTime</command:parameterValue> </command:parameterValueGroup> </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">LogStatus[]</command:parameterValue> <dev:type> <maml:name>PrtgAPI.LogStatus[]</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 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> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>PrtgAPI.Objects.Shared.SensorOrDeviceOrGroupOrProbe</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Object to retrieve logs for. If no object is specified, defaults to the root object (group ID: 0)</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>PrtgAPI.LogStatus[]</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: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:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>C:\> Get-ObjectLog</dev:code> <dev:remarks> <maml:para>Retrieve all logs from the root group (ID: 0) from today.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>C:\> Get-ObjectLog -Count 4000</dev:code> <dev:remarks> <maml:para>Retrieve the last 4000 logs from the root group.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 3 ----------</maml:title> <dev:code>C:\> Get-Device dc-1 | Get-ObjectLog</dev:code> <dev:remarks> <maml:para>Retrieve all logs on device "dc-1" for the last week.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 4 ----------</maml:title> <dev:code>C:\> Get-ObjectLog -Start (Get-Date).AddDays(-3)</dev:code> <dev:remarks> <maml:para>Retrieve all logs from the root node from 3 and 4 days ago.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 5 ----------</maml:title> <dev:code>C:\> Get-Sensor -Id 2460 | Get-ObjectLog -EndDate (Get-Date).AddDays(-4)</dev:code> <dev:remarks> <maml:para>Retrieve all logs from the sensor with ID 2460 between now and 4 days ago.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 6 ----------</maml:title> <dev:code>C:\> Get-Probe *contoso* | Get-ObjectLog -Since LastWeek</dev:code> <dev:remarks> <maml:para>Retrieve all logs from all probes whose name contains "contoso" between now and last week.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 7 ----------</maml:title> <dev:code>C:\> Get-ObjectLog -Status ProbeDisconnected -Count 3</dev:code> <dev:remarks> <maml:para>Retrieve the last 3 times a probe disconnected.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 8 ----------</maml:title> <dev:code>C:\> Get-Device exch-1 | Get-ObjectLog ping | select -First 4</dev:code> <dev:remarks> <maml:para>Retrieve the last 4 events that occurred to the sensor named "ping" on the device named "exch-1".</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> <maml:description> <maml:para>The Set-ObjectPosition cmdlet adjusts the position of an object under its parent node. Set-ObjectPosition allows you to specify the absolute position amongst the list siblings you'd like your object to occupy. If a value lower than 1 or higher than the total number of objects under the parent object is specified, PRTG will automatically place this object first or last in the list.</maml:para> </maml:description> <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>Base class for Sensors, Devices, Groups and Probes, containing properties that apply to all four object types.</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: PassThru --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PassThru</maml:name> <maml:description> <maml:para>Specifies whether to return the original PrtgObject that was passed to this cmdlet, allowing the object to be further piped into additional cmdlets.</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 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>Base class for Sensors, Devices, Groups and Probes, containing properties that apply to all four object types.</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> <!-- Parameter: PassThru --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PassThru</maml:name> <maml:description> <maml:para>Specifies whether to return the original PrtgObject that was passed to this cmdlet, allowing the object to be further piped into additional cmdlets.</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 move.</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 3045 | Set-ObjectPosition 1</dev:code> <dev:remarks> <maml:para>Move the sensor with ID 3045 to be first in the list under its parent.</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-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: DefaultSet --> <command:syntaxItem> <maml:name>Get-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 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>Base class for Sensors, Devices, Groups and Probes, containing properties that apply to all four object types.</maml:para> </maml:description> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: PropertySet --> <command:syntaxItem> <maml:name>Get-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 name of one or more properties to retrieve. Note: PRTG does not support retrieving inheritance settings in via direct API calls.</maml:para> </maml:description> <command:parameterValue required="true">ObjectProperty[]</command:parameterValue> <dev:type> <maml:name>PrtgAPI.ObjectProperty[]</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 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>Base class for Sensors, Devices, Groups and Probes, containing properties that apply to all four object types.</maml:para> </maml:description> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: RawPropertySet --> <command:syntaxItem> <maml:name>Get-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 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>Base class for Sensors, Devices, Groups and Probes, containing properties that apply to all four object types.</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 one or more properties 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> <!-- Parameter set: RawSet --> <command:syntaxItem> <maml:name>Get-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 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>Base class for Sensors, Devices, Groups and Probes, containing properties that apply to all four object types.</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: Raw --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Raw</maml:name> <maml:description> <maml:para>Retrieve all raw properties from the target object.</maml:para> <maml:para>Note: objects may have additional properties that cannot be retrieved via this method. For more information, see Get-Help about_ObjectProperty</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 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>Base class for Sensors, Devices, Groups and Probes, containing properties that apply to all four object types.</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 name of one or more properties to retrieve. Note: PRTG does not support retrieving inheritance settings in via direct API calls.</maml:para> </maml:description> <command:parameterValue required="true">ObjectProperty[]</command:parameterValue> <dev:type> <maml:name>PrtgAPI.ObjectProperty[]</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 one or more properties 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> <!-- Parameter: Raw --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Raw</maml:name> <maml:description> <maml:para>Retrieve all raw properties from the target object.</maml:para> <maml:para>Note: objects may have additional properties that cannot be retrieved via this method. For more information, see Get-Help about_ObjectProperty</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 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 a PRTG 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:para>By default, Set-ObjectProperty will operate in Batch Mode. In Batch Mode, Set-ObjectProperty will not execute a request for each individual object, but will rather store each item in a queue to modify object properties for all objects at once, via a single request. This allows PrtgAPI to be extremely performant in performing operations against a large number of objects.</maml:para> <maml:para>If the pipeline is cancelled (either due to a cmdlet throwing an exception or the user pressing Ctrl-C) before fully completing, Set-ObjectProperty will not generate a request against PRTG. If you wish to disable Batch Mode and fully process objects individually one at a time, this can be achieved by specifying -Batch:$false.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: DefaultSet --> <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, InheritLocation, Location, InheritWindowsCredentials, WindowsDomain, WindowsUserName, WindowsPassword, InheritLinuxCredentials, LinuxUserName, LinuxLoginMode, LinuxPassword, LinuxPrivateKey, WbemProtocolMode, WbemPortMode, WbemPort, SSHPort, SSHElevationMode, SSHElevationSuUser, SSHElevationSudoUser, SSHElevationPassword, SSHEngine, InheritVMwareCredentials, VMwareUserName, VMwarePassword, VMwareProtocol, VMwareSessionMode, InheritSNMPCredentials, SNMPVersion, SNMPCommunityStringV1, SNMPCommunityStringV2, SNMPv3AuthType, SNMPv3UserName, SNMPv3Password, SNMPv3EncryptionType, SNMPv3EncryptionKey, SNMPv3Context, SNMPPort, SNMPTimeout, InheritDBCredentials, DBPortMode, DBPort, DBAuthMode, DBUserName, DBPassword, DBTimeout, InheritAmazonCredentials, AmazonAccessKey, AmazonSecretKey, InheritWindowsCompatibility, WmiDataSource, WmiTimeoutMethod, WmiTimeout, InheritSNMPCompatibility, SNMPDelay, SNMPRetryMode, SNMPOverflowMode, SNMPZeroValueMode, SNMPCounterMode, SNMPRequestMode, SNMPPortNameTemplate, SNMPPortNameUpdateMode, SNMPPortIdMode, SNMPInterfaceStartIndex, SNMPInterfaceEndIndex, InheritAccess, Name, Tags, Priority, DebugMode, Url, HttpRequestMethod, PostData, UseCustomPostContent, PostContentType, UseSNIFromUrl, InheritProxy, ProxyAddress, ProxyPort, ProxyUser, ProxyPassword, Timeout, PingPacketSize, PingMode, PingCount, PingDelay, AutoAcknowledge, InheritInterval, Interval, IntervalErrorMode, GraphType, ExeFile, ExeParameters, SetExeEnvironmentVariables, UseWindowsAuthentication, Mutex, EnableChangeTriggers, WmiMode, Target, PingRemotePacketSize, ChannelDefinition, FactoryErrorMode, FactoryErrorFormula, FactoryMissingDataMode, StartStopped, NotifyStarted, MonitorPerformance, Database, UseCustomInstance, InstanceName, SqlEncryptionMode, SqlServerQuery, UseSqlInputParameter, SqlInputParameter, SqlTransactionMode, SqlProcessingMode, InheritTriggers, Comments, Host, Hostv4, Hostv6, ServiceUrl, AutoDiscoveryMode, AutoDiscoverySchedule</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">InheritLocation</command:parameterValue> <command:parameterValue required="false" variableLength="false">Location</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">WindowsPassword</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">LinuxPassword</command:parameterValue> <command:parameterValue required="false" variableLength="false">LinuxPrivateKey</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">SSHElevationSuUser</command:parameterValue> <command:parameterValue required="false" variableLength="false">SSHElevationSudoUser</command:parameterValue> <command:parameterValue required="false" variableLength="false">SSHElevationPassword</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">VMwarePassword</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">SNMPv3Password</command:parameterValue> <command:parameterValue required="false" variableLength="false">SNMPv3EncryptionType</command:parameterValue> <command:parameterValue required="false" variableLength="false">SNMPv3EncryptionKey</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">DBPassword</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">AmazonSecretKey</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">PostData</command:parameterValue> <command:parameterValue required="false" variableLength="false">UseCustomPostContent</command:parameterValue> <command:parameterValue required="false" variableLength="false">PostContentType</command:parameterValue> <command:parameterValue required="false" variableLength="false">UseSNIFromUrl</command:parameterValue> <command:parameterValue required="false" variableLength="false">InheritProxy</command:parameterValue> <command:parameterValue required="false" variableLength="false">ProxyAddress</command:parameterValue> <command:parameterValue required="false" variableLength="false">ProxyPort</command:parameterValue> <command:parameterValue required="false" variableLength="false">ProxyUser</command:parameterValue> <command:parameterValue required="false" variableLength="false">ProxyPassword</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">ExeFile</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:parameterValue required="false" variableLength="false">ChannelDefinition</command:parameterValue> <command:parameterValue required="false" variableLength="false">FactoryErrorMode</command:parameterValue> <command:parameterValue required="false" variableLength="false">FactoryErrorFormula</command:parameterValue> <command:parameterValue required="false" variableLength="false">FactoryMissingDataMode</command:parameterValue> <command:parameterValue required="false" variableLength="false">StartStopped</command:parameterValue> <command:parameterValue required="false" variableLength="false">NotifyStarted</command:parameterValue> <command:parameterValue required="false" variableLength="false">MonitorPerformance</command:parameterValue> <command:parameterValue required="false" variableLength="false">Database</command:parameterValue> <command:parameterValue required="false" variableLength="false">UseCustomInstance</command:parameterValue> <command:parameterValue required="false" variableLength="false">InstanceName</command:parameterValue> <command:parameterValue required="false" variableLength="false">SqlEncryptionMode</command:parameterValue> <command:parameterValue required="false" variableLength="false">SqlServerQuery</command:parameterValue> <command:parameterValue required="false" variableLength="false">UseSqlInputParameter</command:parameterValue> <command:parameterValue required="false" variableLength="false">SqlInputParameter</command:parameterValue> <command:parameterValue required="false" variableLength="false">SqlTransactionMode</command:parameterValue> <command:parameterValue required="false" variableLength="false">SqlProcessingMode</command:parameterValue> <command:parameterValue required="false" variableLength="false">InheritTriggers</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">Hostv4</command:parameterValue> <command:parameterValue required="false" variableLength="false">Hostv6</command:parameterValue> <command:parameterValue required="false" variableLength="false">ServiceUrl</command:parameterValue> <command:parameterValue required="false" variableLength="false">AutoDiscoveryMode</command:parameterValue> <command:parameterValue required="false" variableLength="false">AutoDiscoverySchedule</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>Base class for Sensors, Devices, Groups and Probes, containing properties that apply to all four object types.</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: Batch --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Batch</maml:name> <maml:description> <maml:para>Specifies whether this cmdlet should queue all objects piped to this cmdlet to execute a single request against PRTG for processing all objects. By default this value is true.</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> <!-- Parameter: PassThru --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PassThru</maml:name> <maml:description> <maml:para>Specifies whether to return the original PrtgObject that was passed to this cmdlet, allowing the object to be further piped into additional cmdlets.</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> <!-- Parameter set: RawSet --> <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>Base class for Sensors, Devices, Groups and Probes, containing properties that apply to all four object types.</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: Batch --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Batch</maml:name> <maml:description> <maml:para>Specifies whether this cmdlet should queue all objects piped to this cmdlet to execute a single request against PRTG for processing all objects. By default this value is true.</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> <!-- 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> <!-- Parameter: PassThru --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PassThru</maml:name> <maml:description> <maml:para>Specifies whether to return the original PrtgObject that was passed to this cmdlet, allowing the object to be further piped into additional cmdlets.</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>Base class for Sensors, Devices, Groups and Probes, containing properties that apply to all four object types.</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, InheritLocation, Location, InheritWindowsCredentials, WindowsDomain, WindowsUserName, WindowsPassword, InheritLinuxCredentials, LinuxUserName, LinuxLoginMode, LinuxPassword, LinuxPrivateKey, WbemProtocolMode, WbemPortMode, WbemPort, SSHPort, SSHElevationMode, SSHElevationSuUser, SSHElevationSudoUser, SSHElevationPassword, SSHEngine, InheritVMwareCredentials, VMwareUserName, VMwarePassword, VMwareProtocol, VMwareSessionMode, InheritSNMPCredentials, SNMPVersion, SNMPCommunityStringV1, SNMPCommunityStringV2, SNMPv3AuthType, SNMPv3UserName, SNMPv3Password, SNMPv3EncryptionType, SNMPv3EncryptionKey, SNMPv3Context, SNMPPort, SNMPTimeout, InheritDBCredentials, DBPortMode, DBPort, DBAuthMode, DBUserName, DBPassword, DBTimeout, InheritAmazonCredentials, AmazonAccessKey, AmazonSecretKey, InheritWindowsCompatibility, WmiDataSource, WmiTimeoutMethod, WmiTimeout, InheritSNMPCompatibility, SNMPDelay, SNMPRetryMode, SNMPOverflowMode, SNMPZeroValueMode, SNMPCounterMode, SNMPRequestMode, SNMPPortNameTemplate, SNMPPortNameUpdateMode, SNMPPortIdMode, SNMPInterfaceStartIndex, SNMPInterfaceEndIndex, InheritAccess, Name, Tags, Priority, DebugMode, Url, HttpRequestMethod, PostData, UseCustomPostContent, PostContentType, UseSNIFromUrl, InheritProxy, ProxyAddress, ProxyPort, ProxyUser, ProxyPassword, Timeout, PingPacketSize, PingMode, PingCount, PingDelay, AutoAcknowledge, InheritInterval, Interval, IntervalErrorMode, GraphType, ExeFile, ExeParameters, SetExeEnvironmentVariables, UseWindowsAuthentication, Mutex, EnableChangeTriggers, WmiMode, Target, PingRemotePacketSize, ChannelDefinition, FactoryErrorMode, FactoryErrorFormula, FactoryMissingDataMode, StartStopped, NotifyStarted, MonitorPerformance, Database, UseCustomInstance, InstanceName, SqlEncryptionMode, SqlServerQuery, UseSqlInputParameter, SqlInputParameter, SqlTransactionMode, SqlProcessingMode, InheritTriggers, Comments, Host, Hostv4, Hostv6, ServiceUrl, AutoDiscoveryMode, AutoDiscoverySchedule</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">InheritLocation</command:parameterValue> <command:parameterValue required="false" variableLength="false">Location</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">WindowsPassword</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">LinuxPassword</command:parameterValue> <command:parameterValue required="false" variableLength="false">LinuxPrivateKey</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">SSHElevationSuUser</command:parameterValue> <command:parameterValue required="false" variableLength="false">SSHElevationSudoUser</command:parameterValue> <command:parameterValue required="false" variableLength="false">SSHElevationPassword</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">VMwarePassword</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">SNMPv3Password</command:parameterValue> <command:parameterValue required="false" variableLength="false">SNMPv3EncryptionType</command:parameterValue> <command:parameterValue required="false" variableLength="false">SNMPv3EncryptionKey</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">DBPassword</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">AmazonSecretKey</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">PostData</command:parameterValue> <command:parameterValue required="false" variableLength="false">UseCustomPostContent</command:parameterValue> <command:parameterValue required="false" variableLength="false">PostContentType</command:parameterValue> <command:parameterValue required="false" variableLength="false">UseSNIFromUrl</command:parameterValue> <command:parameterValue required="false" variableLength="false">InheritProxy</command:parameterValue> <command:parameterValue required="false" variableLength="false">ProxyAddress</command:parameterValue> <command:parameterValue required="false" variableLength="false">ProxyPort</command:parameterValue> <command:parameterValue required="false" variableLength="false">ProxyUser</command:parameterValue> <command:parameterValue required="false" variableLength="false">ProxyPassword</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">ExeFile</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:parameterValue required="false" variableLength="false">ChannelDefinition</command:parameterValue> <command:parameterValue required="false" variableLength="false">FactoryErrorMode</command:parameterValue> <command:parameterValue required="false" variableLength="false">FactoryErrorFormula</command:parameterValue> <command:parameterValue required="false" variableLength="false">FactoryMissingDataMode</command:parameterValue> <command:parameterValue required="false" variableLength="false">StartStopped</command:parameterValue> <command:parameterValue required="false" variableLength="false">NotifyStarted</command:parameterValue> <command:parameterValue required="false" variableLength="false">MonitorPerformance</command:parameterValue> <command:parameterValue required="false" variableLength="false">Database</command:parameterValue> <command:parameterValue required="false" variableLength="false">UseCustomInstance</command:parameterValue> <command:parameterValue required="false" variableLength="false">InstanceName</command:parameterValue> <command:parameterValue required="false" variableLength="false">SqlEncryptionMode</command:parameterValue> <command:parameterValue required="false" variableLength="false">SqlServerQuery</command:parameterValue> <command:parameterValue required="false" variableLength="false">UseSqlInputParameter</command:parameterValue> <command:parameterValue required="false" variableLength="false">SqlInputParameter</command:parameterValue> <command:parameterValue required="false" variableLength="false">SqlTransactionMode</command:parameterValue> <command:parameterValue required="false" variableLength="false">SqlProcessingMode</command:parameterValue> <command:parameterValue required="false" variableLength="false">InheritTriggers</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">Hostv4</command:parameterValue> <command:parameterValue required="false" variableLength="false">Hostv6</command:parameterValue> <command:parameterValue required="false" variableLength="false">ServiceUrl</command:parameterValue> <command:parameterValue required="false" variableLength="false">AutoDiscoveryMode</command:parameterValue> <command:parameterValue required="false" variableLength="false">AutoDiscoverySchedule</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> <!-- Parameter: Batch --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Batch</maml:name> <maml:description> <maml:para>Specifies whether this cmdlet should queue all objects piped to this cmdlet to execute a single request against PRTG for processing all objects. By default this value is true.</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> <!-- Parameter: PassThru --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PassThru</maml:name> <maml:description> <maml:para>Specifies whether to return the original PrtgObject that was passed to this cmdlet, allowing the object to be further piped into additional cmdlets.</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>Get-Help ObjectSettings</maml:linkText> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-Help 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>Get-Probe provides two parameter sets for filtering objects by tags. When filtering for probes that contain one of several tags, the -Tag parameter can be used, performing a logical OR between all specified operands. For scenarios in which you wish to filter for probes containing ALL specified tags, the -Tags parameter can be used, performing a logical AND between all specified operands.</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: Tags --> <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">int[]</command:parameterValue> <dev:type> <maml:name>System.Int32[]</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 all specified 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> <!-- Parameter set: Tag --> <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">int[]</command:parameterValue> <dev:type> <maml:name>System.Int32[]</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: Tag --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Tag</maml:name> <maml:description> <maml:para>Filter the response to objects with one of several 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: 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: 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">int[]</command:parameterValue> <dev:type> <maml:name>System.Int32[]</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 all specified 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: Tag --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Tag</maml:name> <maml:description> <maml:para>Filter the response to objects with one of several 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: 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> </command:parameters> <command:inputTypes> <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: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: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:\> flt 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: Restart-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>Restart-Probe</command:name> <command:verb>Restart</command:verb> <command:noun>Probe</command:noun> <maml:description> <maml:para>Restarts the PRTG Probe Service of PRTG Network Monitor probes.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Restart-Probe cmdlet restarts the PRTG Probe Service of a specified PRTG Probe. If no probe is specified, Restart-Probe will restart the PRTG Probe Service of all PRTG Probes in your environment.</maml:para> <maml:para>When executed, Restart-Probe will prompt to confirm you wish to restart the PRTG Probe Service of each PRTG Probe. Within this prompt you may respond to each probe individually or answer yes/no to all. To override this prompt completely, the -Force parameter can be specified.</maml:para> <maml:para>By default, Restart-Probe will wait for one hour for all probes restart and reconnect to PRTG. If you do not wish to wait at all, this can be overridden by specifying -Wait:$false. You may additionally specify a custom timeout duration (in seconds) via the -Timeout parameter. If Restart-Probe times out waiting for a PRTG Probe Service to restart, a TimeoutException will be thrown specifying the number of probes that failed to restart.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Restart-Probe</maml:name> <!-- Parameter: Force --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Forces the PRTG Probe Service to be restarted on all specified probes 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> <!-- Parameter: PassThru --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PassThru</maml:name> <maml:description> <maml:para>Specifies whether to return the original PrtgObject that was passed to this cmdlet, allowing the object to be further piped into additional cmdlets.</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: Probe --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Probe</maml:name> <maml:description> <maml:para>The probe to restart. If no probe is specified, all probes will be restarted.</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: Timeout --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Timeout</maml:name> <maml:description> <maml:para>Duration (in seconds) to wait for the PRTG Probe Service of all probes to restart. Default value is 3600 (1 hour). If Wait is false, this parameter will have no effect.</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>3600</dev:defaultValue> </command:parameter> <!-- Parameter: Wait --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Wait</maml:name> <maml:description> <maml:para>Wait for the PRTG Core Service to restart before ending the cmdlet. By default this value is true.</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: Probe --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Probe</maml:name> <maml:description> <maml:para>The probe to restart. If no probe is specified, all probes will be restarted.</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: PassThru --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PassThru</maml:name> <maml:description> <maml:para>Specifies whether to return the original PrtgObject that was passed to this cmdlet, allowing the object to be further piped into additional cmdlets.</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: Force --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Forces the PRTG Probe Service to be restarted on all specified probes 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> <!-- Parameter: Wait --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Wait</maml:name> <maml:description> <maml:para>Wait for the PRTG Core Service to restart before ending the cmdlet. By default this value is true.</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> <!-- Parameter: Timeout --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Timeout</maml:name> <maml:description> <maml:para>Duration (in seconds) to wait for the PRTG Probe Service of all probes to restart. Default value is 3600 (1 hour). If Wait is false, this parameter will have no effect.</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>3600</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>PrtgAPI.Probe</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The probe to restart. If no probe is specified, all probes will be restarted.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>C:\> Restart-Probe</dev:code> <dev:remarks> <maml:para>Restart all probes on a PRTG Server and wait for them to restart.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>C:\> Get-Probe *contoso* | Restart-Probe -Timeout 180 -Force</dev:code> <dev:remarks> <maml:para>Restart all probes containing "contoso" in their names, waiting 3 minutes for them to restart, without displaying a confirmation prompt.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 3 ----------</maml:title> <dev:code>Get-Probe -Id 2004 | Restart-Probe -Wait:$false</dev:code> <dev:remarks> <maml:para>Restart the probe with ID 2004, without waiting for the probe to restart.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Get-Probe</maml:linkText> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Restart-PrtgCore</maml:linkText> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Clear-PrtgCache --> <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>Clear-PrtgCache</command:name> <command:verb>Clear</command:verb> <command:noun>PrtgCache</command:noun> <maml:description> <maml:para>Clears cached data used by a PRTG Network Monitor server.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Clear-PrtgCache cmdlet clears Geo Map, Active Directory authentication and Graph Data details from a PRTG server. Geo Map and Active Directory authentication caches are grouped together under the General cache type. Graph Data is cleared separately, under the GraphData cache type.</maml:para> <maml:para>When Graph Data is cleared, the PRTG Core Service will automatically restart. To prevent this happening accidentally, Clear-PrtgCache will prompt you to confirm you are sure you wish to proceed. This can be overridden by specifying the -Force parameter.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Clear-PrtgCache</maml:name> <!-- Parameter: Type --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>Type</maml:name> <maml:description> <maml:para>The type of cache to clear.</maml:para> <maml:para>Possible values: General, GraphData</maml:para> </maml:description> <command:parameterValue required="true">SystemCacheType</command:parameterValue> <dev:type> <maml:name>PrtgAPI.SystemCacheType</maml:name> <maml:uri /> <maml:description> <maml:para>Specifies types of caches that exist on a PRTG Network Monitor server.</maml:para> </maml:description> </dev:type> <dev:defaultValue>General</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">General</command:parameterValue> <command:parameterValue required="false" variableLength="false">GraphData</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: Force --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Forces PRTG to clear caches that may cause a reboot of the PRTG Server 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: Type --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>Type</maml:name> <maml:description> <maml:para>The type of cache to clear.</maml:para> <maml:para>Possible values: General, GraphData</maml:para> </maml:description> <command:parameterValue required="true">SystemCacheType</command:parameterValue> <dev:type> <maml:name>PrtgAPI.SystemCacheType</maml:name> <maml:uri /> <maml:description> <maml:para>Specifies types of caches that exist on a PRTG Network Monitor server.</maml:para> </maml:description> </dev:type> <dev:defaultValue>General</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">General</command:parameterValue> <command:parameterValue required="false" variableLength="false">GraphData</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: Force --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Forces PRTG to clear caches that may cause a reboot of the PRTG Server 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:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>C:\> Clear-PrtgCache General</dev:code> <dev:remarks> <maml:para>Clear Geo Map and Active Directory authentication caches.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>C:\> Clear-PrtgCache GraphData -Force</dev:code> <dev:remarks> <maml:para>Clear PRTG's graph data cache without displaying a confirmation prompt that this will restart the PRTG Core Service.</maml:para> </dev:remarks> </command:example> </command:examples> </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: Backup-PrtgConfig --> <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>Backup-PrtgConfig</command:name> <command:verb>Backup</command:verb> <command:noun>PrtgConfig</command:noun> <maml:description> <maml:para>Requests a PRTG Network Monitor server create a backup of its configuration database.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Backup-PrtgConfig cmdlet requests a PRTG Network Monitor server create a backup of its configuration database after first writing the current running configuration to disk. Configuration backups are stored under the Configuration Auto-Backups folder, by default located at C:\ProgramData\Paessler\PRTG Network Monitor\Configuration Auto-Backups</maml:para> <maml:para>When this cmdlet is executed, PRTG will asynchronously start creating a configuration backup. As such, this cmdlet will return before the backup has completed. Depending on the size of your configuration database, this may take several seconds to complete. In order to guarantee a backup has been successfully completed, it is recommended to probe the contents of the Configuration Auto-Backups folder before and after running this script, to identify the backup file that was created as a result of running this cmdlet. The created backup can also be identified by parsing the DateTime timestamp in the created filename, typically "PRTG Configuration (Snapshot yyyy-MM-dd HH-mm-ss)"</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Backup-PrtgConfig</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:\> Backup-PrtgConfig</dev:code> <dev:remarks> <maml:para>Trigger a backup of the PRTG Configuration Database.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!-- Cmdlet: Sync-PrtgConfigFile --> <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>Sync-PrtgConfigFile</command:name> <command:verb>Sync</command:verb> <command:noun>PrtgConfigFile</command:noun> <maml:description> <maml:para>Reloads config files including sensor lookups and device icons used by PRTG Network Monitor.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Load-PrtgConfigFile cmdlet reloads miscellaneous config files used by PRTG Network Monitor, including lookup definitions used for customizing how sensor values are displayed, as well as other miscellaneous config files including device icons, report templates and language files.</maml:para> <maml:para>Config files used by PRTG are automatically reloaded whenever the PRTG Core Service is restarted. To prevent having to completely restart PRTG whenever a config file is installed or modified, Load-PrtgConfigFile can instead be used.</maml:para> <maml:para>Device icons, report templates and language files are refreshed together by a single request, categorised by PrtgAPI as the General config file type. Sensor lookups are reloaded separately, under the Lookups file type.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Sync-PrtgConfigFile</maml:name> <!-- Parameter: Type --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>Type</maml:name> <maml:description> <maml:para>The type of config files to reload.</maml:para> <maml:para>Possible values: General, Lookups</maml:para> </maml:description> <command:parameterValue required="true">ConfigFileType</command:parameterValue> <dev:type> <maml:name>PrtgAPI.ConfigFileType</maml:name> <maml:uri /> <maml:description> <maml:para>Specifies types of config files that can be loaded by PRTG.</maml:para> </maml:description> </dev:type> <dev:defaultValue>General</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">General</command:parameterValue> <command:parameterValue required="false" variableLength="false">Lookups</command:parameterValue> </command:parameterValueGroup> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Type --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>Type</maml:name> <maml:description> <maml:para>The type of config files to reload.</maml:para> <maml:para>Possible values: General, Lookups</maml:para> </maml:description> <command:parameterValue required="true">ConfigFileType</command:parameterValue> <dev:type> <maml:name>PrtgAPI.ConfigFileType</maml:name> <maml:uri /> <maml:description> <maml:para>Specifies types of config files that can be loaded by PRTG.</maml:para> </maml:description> </dev:type> <dev:defaultValue>General</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">General</command:parameterValue> <command:parameterValue required="false" variableLength="false">Lookups</command:parameterValue> </command:parameterValueGroup> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>C:\> Load-PrtgConfigFile General</dev:code> <dev:remarks> <maml:para>Reload any device icons, report templates or language files that may have been installed or modified since PRTG started.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>C:\> Load-PrtgConfigFile Lookups</dev:code> <dev:remarks> <maml:para>Loads or reloads any sensor lookups that may have been changed or installed since PRTG was started.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!-- Cmdlet: Restart-PrtgCore --> <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>Restart-PrtgCore</command:name> <command:verb>Restart</command:verb> <command:noun>PrtgCore</command:noun> <maml:description> <maml:para>Restarts the PRTG Core Service of a PRTG Network Monitor server.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Restart-PrtgCore cmdlet restarts the PRTG Core Service of a PRTG Network Monitor Server. Upon restarting the service, all monitoring will cease functioning and all users will be completely disconnected. If PRTG is in a cluster setup, this cmdlet will only restart the PRTG Core Service of the server PrtgAPI is connected to.</maml:para> <maml:para>When executed, Restart-PrtgCore will prompt to confirm you wish to restart the PRTG Core Service. To override this prompt, the -Force parameter can be specified.By default, Restart-PrtgCore will one hour for the PRTG Core Service to completely restart and come back online. If you do not wish to wait at all, this can be overridden by specifying -Wait:$false. You may additionally specify a custom timeout duration (in seconds) via the -Timeout parameter. If Restart-PrtgCore times out waiting for the PRTG Core Service to restart, a TimeoutException will be thrown. Extreme caution should be used when using Restart-PrtgCore. While smaller PRTG installs can restart in a matter of minutes, servers containing in excess of 10,000 sensors can take over half an hour to restart.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Restart-PrtgCore</maml:name> <!-- Parameter: Force --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Forces the PRTG Core Service to be restarted 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> <!-- Parameter: Timeout --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Timeout</maml:name> <maml:description> <maml:para>Duration (in seconds) to wait for the PRTG Core Service to restart. Default value is 3600 (1 hour). If Wait is false, this parameter will have no effect.</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>3600</dev:defaultValue> </command:parameter> <!-- Parameter: Wait --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Wait</maml:name> <maml:description> <maml:para>Wait for the PRTG Core Service to restart before ending the cmdlet. By default this value is true.</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: Force --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Forces the PRTG Core Service to be restarted 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> <!-- Parameter: Wait --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Wait</maml:name> <maml:description> <maml:para>Wait for the PRTG Core Service to restart before ending the cmdlet. By default this value is true.</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> <!-- Parameter: Timeout --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Timeout</maml:name> <maml:description> <maml:para>Duration (in seconds) to wait for the PRTG Core Service to restart. Default value is 3600 (1 hour). If Wait is false, this parameter will have no effect.</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>3600</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>C:\> Restart-PrtgCore</dev:code> <dev:remarks> <maml:para>Restart the PRTG Core Service. The cmdlet will wait up to 60 minutes for the service to restart.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>C:\> Restart-PrtgCore -Wait:$false</dev:code> <dev:remarks> <maml:para>Restart the PRTG Core Service, without waiting for the service to restart before ending the cmdlet.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 3 ----------</maml:title> <dev:code>C:\> Restart-PrtgCore -Timeout 600</dev:code> <dev:remarks> <maml:para>Restart the PRTG Core Service, waiting 10 minutes (600 seconds) for the service to restart.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Restart-Probe</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>Base class for Sensors, Devices, Groups and Probes, containing properties that apply to all four object types.</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>Base class for Sensors, Devices, Groups and Probes, containing properties that apply to all four object types.</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: Get-PrtgStatus --> <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-PrtgStatus</command:name> <command:verb>Get</command:verb> <command:noun>PrtgStatus</command:noun> <maml:description> <maml:para>Retrieves configuration, status and version details from a PRTG Server.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Get-PrtgStatus cmdlet retrieves status details from a PRTG Server, including details regarding sensor types, license and version details, cluster config and user access rights.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Get-PrtgStatus</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:\> Get-PrtgStatus</dev:code> <dev:remarks> <maml:para>Retrieve the current system status.</maml:para> </dev:remarks> </command:example> </command:examples> </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, StartDate, EndDate, RecordAge</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:parameterValue required="false" variableLength="false">StartDate</command:parameterValue> <command:parameterValue required="false" variableLength="false">EndDate</command:parameterValue> <command:parameterValue required="false" variableLength="false">RecordAge</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, StartDate, EndDate, RecordAge</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:parameterValue required="false" variableLength="false">StartDate</command:parameterValue> <command:parameterValue required="false" variableLength="false">EndDate</command:parameterValue> <command:parameterValue required="false" variableLength="false">RecordAge</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: Add-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>Add-Sensor</command:name> <command:verb>Add</command:verb> <command:noun>Sensor</command:noun> <maml:description> <maml:para>Adds a new sensor to a PRTG Device.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Add-Sensor cmdlet adds a new sensor to a PRTG Device. When adding a new sensor, you must first create a NewSensorParameters object that defines the type of sensor to create and the settings to use in the new object.</maml:para> <maml:para>When adding sensor types that are natively supported by PrtgAPI, Add-Sensor will validate that all mandatory parameter fields contain values. If a mandatory field is missing a value, Add-Sensor will throw an InvalidOperationException, listing the field whose value was missing. When adding unsupported sensor types defined in RawSensorParameters, Add-Sensor does not perform any parameter validation. As such, it is critical to ensure that all parameter names and values are valid before passing the parameters to the Add-Sensor cmdlet.</maml:para> <maml:para>For parameter types that support specifying multiple SensorTarget objects (such as WmiServiceSensorParameters) PRTG can fail to add all sensors properly if the size of a single request is too large (generally 60 items or greater). To prevent this issue from happening, PrtgAPI automatically splits your request into a series of smaller requests, however if you find yourself experiencing issues, this is something to be aware of.</maml:para> <maml:para>By default, Add-Sensor will attempt to resolve the created sensor(s) to one or more Sensor objects. As PRTG does not return the ID of the created object, PrtgAPI identifies the newly created group by comparing the sensors under the parent object before and after the new sensor(s) are created. While this is generally very reliable, in the event something or someone else creates another new sensor directly under the target object with the same Name, that object will also be returned in the objects resolved by Add-Sensor. If you do not wish to resolve the created sensor, this behavior can be disabled by specifying -Resolve:$false.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: DefaultSet --> <command:syntaxItem> <maml:name>Add-Sensor</maml:name> <!-- Parameter: Parameters --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>Parameters</maml:name> <maml:description> <maml:para>A set of parameters whose properties describe the type of object to add, with what settings.</maml:para> </maml:description> <command:parameterValue required="true">NewSensorParameters</command:parameterValue> <dev:type> <maml:name>PrtgAPI.Parameters.NewSensorParameters</maml:name> <maml:uri /> <maml:description> <maml:para>Represents parameters used to construct a PrtgUrl for adding new Sensor objects.</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: Parameters --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>Parameters</maml:name> <maml:description> <maml:para>A set of parameters whose properties describe the type of object to add, with what settings.</maml:para> </maml:description> <command:parameterValue required="true">NewSensorParameters</command:parameterValue> <dev:type> <maml:name>PrtgAPI.Parameters.NewSensorParameters</maml:name> <maml:uri /> <maml:description> <maml:para>Represents parameters used to construct a PrtgUrl for adding new Sensor objects.</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: Destination --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Destination</maml:name> <maml:description> <maml:para>The parent object to create an object under.</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 new object should be resolved to a PrtgObject. By default this value is Present.</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> <!-- Parameter set: TargetSet --> <command:syntaxItem> <maml:name>Add-Sensor</maml:name> <!-- Parameter: Parameters --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Parameters</maml:name> <maml:description> <maml:para>A set of parameters whose properties describe the type of object to add, with what settings.</maml:para> </maml:description> <command:parameterValue required="true">NewSensorParameters</command:parameterValue> <dev:type> <maml:name>PrtgAPI.Parameters.NewSensorParameters</maml:name> <maml:uri /> <maml:description> <maml:para>Represents parameters used to construct a PrtgUrl for adding new Sensor objects.</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 new object should be resolved to a PrtgObject. By default this value is Present.</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: Parameters --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Parameters</maml:name> <maml:description> <maml:para>A set of parameters whose properties describe the type of object to add, with what settings.</maml:para> </maml:description> <command:parameterValue required="true">NewSensorParameters</command:parameterValue> <dev:type> <maml:name>PrtgAPI.Parameters.NewSensorParameters</maml:name> <maml:uri /> <maml:description> <maml:para>Represents parameters used to construct a PrtgUrl for adding new Sensor objects.</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: Destination --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Destination</maml:name> <maml:description> <maml:para>The parent object to create an object under.</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: Parameters --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>Parameters</maml:name> <maml:description> <maml:para>A set of parameters whose properties describe the type of object to add, with what settings.</maml:para> </maml:description> <command:parameterValue required="true">NewSensorParameters</command:parameterValue> <dev:type> <maml:name>PrtgAPI.Parameters.NewSensorParameters</maml:name> <maml:uri /> <maml:description> <maml:para>Represents parameters used to construct a PrtgUrl for adding new Sensor objects.</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 new object should be resolved to a PrtgObject. By default this value is Present.</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.Parameters.NewSensorParameters</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>A set of parameters whose properties describe the type of object to add, with what settings.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>PrtgAPI.Device</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The parent object to create an object under.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>C:\> $params = New-SensorParameters ExeXml "Monitor Traffic" "TrafficMonitor.ps1"</dev:code> <dev:remarks> <maml:para>C:\> Get-Device *fw* | Add-Sensor $params</maml:para> <maml:para>Add an EXE/Script Advanced sensor to all firewall devices, using the script "TrafficMonitor.ps1"</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>C:\> $raw = @{</dev:code> <dev:remarks> <maml:para>>> name_ = "my raw sensor"</maml:para> <maml:para>>> tags_ = "xmlexesensor"</maml:para> <maml:para>>> priority_ = 4</maml:para> <maml:para>>> exefile_ = "CustomScript.ps1|CustomScript.ps1||</maml:para> <maml:para>>> exeparams_ = "arg1 arg2 arg3"</maml:para> <maml:para>>> environment_ = 1</maml:para> <maml:para>>> usewindowsauthentication_ = 1</maml:para> <maml:para>>> mutexname_ = "testMutex"</maml:para> <maml:para>>> timeout_ = 70</maml:para> <maml:para>>> writeresult_ = 1</maml:para> <maml:para>>> intervalgroup = 0</maml:para> <maml:para>>> interval_ = "30|30 seconds"</maml:para> <maml:para>>> errorintervalsdown_ = 2</maml:para> <maml:para>>> sensortype = "exexml"</maml:para> <maml:para>>> }</maml:para> <maml:para>C:\> $params = New-SensorParameters $raw</maml:para> <maml:para>C:\> Get-Device dc-1 | Add-Sensor $params</maml:para> <maml:para>Add a new EXE/Script Advanced sensor to the device named dc-1 using its raw parameters</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Get-Device</maml:linkText> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-SensorParameters</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:para>By default, Acknowledge-Sensor will operate in Batch Mode. In Batch Mode, Acknowledge-Sensor will not execute a request for each individual object, but will rather store each item in a queue to acknowledge all objects at once, via a single request. This allows PrtgAPI to be extremely performant in performing operations against a large number of objects.</maml:para> <maml:para>If the pipeline is cancelled (either due to a cmdlet throwing an exception or the user pressing Ctrl-C) before fully completing, Acknowledge-Sensor will not generate a request against PRTG. If you wish to disable Batch Mode and fully process objects individually one at a time, this can be achieved by specifying -Batch:$false.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: DefaultSet --> <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> <dev:defaultValue>0</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: Batch --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Batch</maml:name> <maml:description> <maml:para>Specifies whether this cmdlet should queue all objects piped to this cmdlet to execute a single request against PRTG for processing all objects. By default this value is true.</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> <!-- 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: PassThru --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PassThru</maml:name> <maml:description> <maml:para>Specifies whether to return the original PrtgObject that was passed to this cmdlet, allowing the object to be further piped into additional cmdlets.</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> <!-- Parameter set: UntilSet --> <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> <dev:defaultValue>1/1/0001 12:00:00 AM</dev:defaultValue> </command:parameter> <!-- Parameter: Batch --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Batch</maml:name> <maml:description> <maml:para>Specifies whether this cmdlet should queue all objects piped to this cmdlet to execute a single request against PRTG for processing all objects. By default this value is true.</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> <!-- 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: PassThru --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PassThru</maml:name> <maml:description> <maml:para>Specifies whether to return the original PrtgObject that was passed to this cmdlet, allowing the object to be further piped into additional cmdlets.</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> <!-- Parameter set: ForeverSet --> <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: Batch --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Batch</maml:name> <maml:description> <maml:para>Specifies whether this cmdlet should queue all objects piped to this cmdlet to execute a single request against PRTG for processing all objects. By default this value is true.</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> <!-- 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: PassThru --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PassThru</maml:name> <maml:description> <maml:para>Specifies whether to return the original PrtgObject that was passed to this cmdlet, allowing the object to be further piped into additional cmdlets.</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: 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> <dev:defaultValue>0</dev:defaultValue> </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> <dev:defaultValue>1/1/0001 12:00:00 AM</dev:defaultValue> </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> <!-- Parameter: Batch --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Batch</maml:name> <maml:description> <maml:para>Specifies whether this cmdlet should queue all objects piped to this cmdlet to execute a single request against PRTG for processing all objects. By default this value is true.</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> <!-- Parameter: PassThru --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PassThru</maml:name> <maml:description> <maml:para>Specifies whether to return the original PrtgObject that was passed to this cmdlet, allowing the object to be further piped into additional cmdlets.</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: 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>Get-Sensor provides two parameter sets for filtering objects by tags. When filtering for sensors that contain one of several tags, the -Tag parameter can be used, performing a logical OR between all specified operands. For scenarios in which you wish to filter for sensors containing ALL specified tags, the -Tags parameter can be used, performing a logical AND between all specified operands.</maml:para> <maml:para>When requesting sensors belonging to a specified group, PRTG will not return any objects that may be present under further child groups of the parent group. To work around this, by default Get-Sensor will automatically recurse child groups if it detects the initial sensor request did not return all items (as evidenced by the parent group's TotalSensors property. If you do not wish Get-Sensor to recurse child groups, this behavior can be overridden by specifying -Recurse:$false.</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: Tags --> <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">int[]</command:parameterValue> <dev:type> <maml:name>System.Int32[]</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: Recurse --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Recurse</maml:name> <maml:description> <maml:para>When piping from a Group, specifies that PrtgAPI should also recursively traverse all subgroups until all objects that should be returned by this cmdlet have been found. By default this value is true. If this value is false, PrtgAPI will not return objects from under any subgroups of the target group.</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> <!-- 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 all specified 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> <!-- Parameter set: Tag --> <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">int[]</command:parameterValue> <dev:type> <maml:name>System.Int32[]</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: Recurse --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Recurse</maml:name> <maml:description> <maml:para>When piping from a Group, specifies that PrtgAPI should also recursively traverse all subgroups until all objects that should be returned by this cmdlet have been found. By default this value is true. If this value is false, PrtgAPI will not return objects from under any subgroups of the target group.</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> <!-- 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: Tag --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Tag</maml:name> <maml:description> <maml:para>Filter the response to objects with one of several 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: Recurse --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Recurse</maml:name> <maml:description> <maml:para>When piping from a Group, specifies that PrtgAPI should also recursively traverse all subgroups until all objects that should be returned by this cmdlet have been found. By default this value is true. If this value is false, PrtgAPI will not return objects from under any subgroups of the target group.</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> <!-- 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: 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">int[]</command:parameterValue> <dev:type> <maml:name>System.Int32[]</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 all specified 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: Tag --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Tag</maml:name> <maml:description> <maml:para>Filter the response to objects with one of several 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: 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> </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.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: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: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 -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 7 ----------</maml:title> <dev:code>C:\> Get-Sensor -Tag wmicpu*,wmimem*</dev:code> <dev:remarks> <maml:para>Get all WMI CPU Load and WMI Memory sensors.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 8 ----------</maml:title> <dev:code>C:\> Get-Sensor -Tags ny,wmicpu*</dev:code> <dev:remarks> <maml:para>Get all WMI CPU Load sensors from all New York devices.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 9 ----------</maml:title> <dev:code>C:\> flt type contains deprecated | Get-Sensor</dev:code> <dev:remarks> <maml:para>Get all deprecated sensors.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 10 ----------</maml:title> <dev:code>C:\> Get-Group -Id 2001 | Get-Sensor -Recurse:$false</dev:code> <dev:remarks> <maml:para>Get all sensors from devices directly under the specified group, ignoring all child groups.</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 PRTG 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: AggregateSet --> <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: Sensor --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Sensor</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: StartId --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>StartId</maml:name> <maml:description> <maml:para>The starting channel ID 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: Sensor --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Sensor</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: StartId --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>StartId</maml:name> <maml:description> <maml:para>The starting channel ID 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 "used" instead of free</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 } -StartId 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-SensorFactorySource --> <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-SensorFactorySource</command:name> <command:verb>Get</command:verb> <command:noun>SensorFactorySource</command:noun> <maml:description> <maml:para>Retrieves source sensors and channels from a PRTG Sensor Factory.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Get-SensorFactorySource cmdlet retrieves the source sensors and channels of PRTG Sensor Factory objects. By default Get-SensorFactorySource retrieves the sensors of the channel definition. If the -Channels parameter is specified, the cmdlet will retrieve the source channels instead. If a sensor is passed to Get-SensorFactorySource that isn't a Sensor Factory, an ParameterBindingException will be thrown.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Get-SensorFactorySource</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 factory sensor to retrieve source sensors or channels of.</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: Channels --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Channels</maml:name> <maml:description> <maml:para>Whether to retrieve the source Channel objects of a sensor factory, instead of the source sensors.</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: Sensor --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Sensor</maml:name> <maml:description> <maml:para>The sensor factory sensor to retrieve source sensors or channels of.</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: Channels --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Channels</maml:name> <maml:description> <maml:para>Whether to retrieve the source Channel objects of a sensor factory, instead of the source sensors.</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 factory sensor to retrieve source sensors or channels of.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>flt type eq "sensor factory" | Get-Sensor -Count 1 | Get-SensorFactorySource</dev:code> <dev:remarks> <maml:para>Retrieve all source sensors of a single sensor factory sensor</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>flt type eq "sensor factory" | Get-Sensor -Count 1 | Get-SensorFactorySource -Channels</dev:code> <dev:remarks> <maml:para>Retrieve all source channels of a single sensor factory sensor</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Get-Sensor</maml:linkText> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-SearchFilter</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 specified, records will be returned from between now and 60 minutes ago. 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>When an EndDate is specified, Get-SensorHistory will split the sensor history query into a series of smaller requests, emitting results to the pipeline as they arrive. If the -Count parameter is speciifed, Get-SensorHistory will limit results to the specified number items within the specified time period.</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:para>Note that while Get-SensorHistory considers the "start time" as being the point in time closest to now and the "end time" as the point in time furthest away from now, PRTG's underlying API actually defines these in the opposite way. Since records are ordered from newest to oldest however, PrtgAPI flips these definitions as to prevent any confusion. Keep this in mind in the event the -Verbose parameter is specified, as the start and end times will appear to be switched.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: DefaultSet --> <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: Count --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Count</maml:name> <maml:description> <maml:para>Limits results to the specified number of items within the specified time period.</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: 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: ManualSet --> <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: Count --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Count</maml:name> <maml:description> <maml:para>Limits results to the specified number of items within the specified time period.</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: 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> <!-- Parameter: Count --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Count</maml:name> <maml:description> <maml:para>Limits results to the specified number of items within the specified time period.</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>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(-1) -EndDate (Get-Date).AddDays(-3)</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: New-SensorParameters --> <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-SensorParameters</command:name> <command:verb>New</command:verb> <command:noun>SensorParameters</command:noun> <maml:description> <maml:para>Creates a new set of sensor parameters for creating a brand new sensor under a device.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The New-SensorParameters cmdlet creates a set of parameters for adding a brand new sensor to PRTG. All sensor types supported by PRTG can be added with New-SensorParameters, however certain types are "natively" supported. For types that are not are natively supported, New-SensorParameters is capable of either dynamically generating the required set of parameters, or creating a completely custom set of parameters from a collection of values manually crafted by hand.</maml:para> <maml:para>Natively supported sensor types allow interfacing with strongly typed properties of a well known object deriving from NewSensorParameters. When a supported type is created, the name to give the sensor can be optionally specified. If a name is not specified, New-SensorParameters will automatically assign the sensor the default name PRTG would assign a sensor of the specified type (e.g. EXE/Script Advanced sensors by default are named "XML Custom EXE/Script Sensor").</maml:para> <maml:para>In addition to the sensor name, certain sensor types contain additional mandatory fields that must be populated before attempting to add the sensor (such as the ExeFile of an EXE/Script Advanced sensor). New-SensorParameters optionally allows you to specify the value of the primary mandatory field of the specified type using the -Value parameter. Fields that require values contain a value of $null by default, however not all fields that are $null are necessarily mandatory. If you attempt to add a natively supported type with missing mandatory fields, PrtgAPI will catch this and alert you that the value that was missing.</maml:para> <maml:para>Beyond type safety, PrtgAPI does not perform any validation that the values you specify to fields are "correct" (e.g. for an EXE/Script Advanced sensor, that the specified file exists). In the event invalid values are specified, PRTG will usually handle the error gracefully, however you are responsible for confirming that any values that are used to create a new sensor as are as correct as possible.</maml:para> <maml:para>For sensor types that are not natively supported, PrtgAPI provides the ability to dynamically generate the set of parameters required to add the specified sensor type. Dynamically generated sensor parameters operate as a hybrid of a both a Dictionary and a PSObject, allowing you to interface with these types as if they are a native object. For sensor types that require Sensor Targets, a dictionary of all identified sensor targets can be found under the dynamic sensor parameter's Targets property. Parameters that appear to contain sensor targets will automatically be wrapped as a GenericSensorTarget, and by default will contain the first target from the list of available candidates.</maml:para> <maml:para>By default, dynamically sensor parameters are "locked", as to prevent additional parameters from being added to the object in the event a typo is made. If you do wish to add additional parameters however, this can be performed by calling the Unlock method on the specified DynamicSensorParameters and then setting the value via the parameter's indexer or via the dynamic property name. Note that DynamicSensorParameters dynamic properties will always show parameters as not containing a trailing underscore as to provide a "cleaner" interface. The raw CustomParameter objects of the parameters can be viewed however by specifying Custom to the object's indexer.</maml:para> <maml:para>If you wish to create your parameters yourself, this can either be done by creating an -Empty set of parameters for you to manually populate, or by defining a hashtable listing all the parameters that are required to create the specified sensor along with their raw associated values. The parameters for creating a specific type of sensor can be discovered via a web debugger such as Fiddler or by inspecting the underlying parameters generated by a set of DynamicSensorParameters.</maml:para> <maml:para>When accessing RawSensorParameters and DynamicSensorParameters via their indexers, by default PowerShell will suppress any exceptions thrown when trying to access non-existent properties, instead simply returning $null. This is due to the default Strict Mode the PowerShell engine runs under. To enable exceptions on accessing invalid paramters, the strict mode must be set to version 3 or higher. For more information, see Get-Help Set-StrictMode.</maml:para> <maml:para>Great care should be taken when adding sensors using raw parameters. As there is no type safety, the possibility of making errors is high. As most raw parameter names end in an underscore, it is critical to ensure these parameters have been named properly. In the event a sensor is added improperly, it can easily be corrected or deleted in the PRTG UI. When specifying a hashtable parameter set to New-SensorParameters, PrtgAPI will validate that at a minimum the 'name_' and 'sensortype' parameters are specified. If either of these two are missing, New-SensorParameters will generate an exception.</maml:para> <maml:para>All sensor parameter types support specifying common sensor parameters (Inherit Triggers, Interval, Priority, etc) via well typed properties. If these properties are not set, PRTG will automatically use the default values for these fields based on the type of sensor being created.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: DefaultSet --> <command:syntaxItem> <maml:name>New-SensorParameters</maml:name> <!-- Parameter: Type --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>Type</maml:name> <maml:description> <maml:para>The type of sensor to create.</maml:para> <maml:para>Possible values: ExeXml, WmiService, SqlServerDB, Http</maml:para> </maml:description> <command:parameterValue required="true">SensorType</command:parameterValue> <dev:type> <maml:name>PrtgAPI.SensorType</maml:name> <maml:uri /> <maml:description> <maml:para>Specifies types of sensors that can be created in PRTG.</maml:para> </maml:description> </dev:type> <dev:defaultValue>ExeXml</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">ExeXml</command:parameterValue> <command:parameterValue required="false" variableLength="false">WmiService</command:parameterValue> <command:parameterValue required="false" variableLength="false">SqlServerDB</command:parameterValue> <command:parameterValue required="false" variableLength="false">Http</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: First --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>First</maml:name> <maml:description> <maml:para>The name to give the new sensor. If no value is specified, the default name of the specified sensor type will be used. If the specified sensor type does not support specifying a name, this field is used for any mandatory values required by the sensor type.</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: Second --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>Second</maml:name> <maml:description> <maml:para>A mandatory value required by the specified sensor type.</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:syntaxItem> <!-- Parameter set: RawSet --> <command:syntaxItem> <maml:name>New-SensorParameters</maml:name> <!-- Parameter: RawParameters --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>RawParameters</maml:name> <maml:description> <maml:para>A collection of raw parameters for adding an unsupported sensor type.</maml:para> </maml:description> <command:parameterValue required="true">Hashtable</command:parameterValue> <dev:type> <maml:name>System.Collections.Hashtable</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: DynamicSet --> <command:syntaxItem> <maml:name>New-SensorParameters</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 create a set of DynamicSensorParameters from.</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: RawType --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>RawType</maml:name> <maml:description> <maml:para>The raw name of the sensor type to create.</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: Target --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Target</maml:name> <maml:description> <maml:para>Wildcard used to specify the sensor targets to assign to a set of DynamicSensorParameters.</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: EmptySet --> <command:syntaxItem> <maml:name>New-SensorParameters</maml:name> <!-- Parameter: Empty --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Empty</maml:name> <maml:description> <maml:para>Specifies that an empty set of RawSensorParameters should be returned to allow constructing a parameter set manually.</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: Type --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>Type</maml:name> <maml:description> <maml:para>The type of sensor to create.</maml:para> <maml:para>Possible values: ExeXml, WmiService, SqlServerDB, Http</maml:para> </maml:description> <command:parameterValue required="true">SensorType</command:parameterValue> <dev:type> <maml:name>PrtgAPI.SensorType</maml:name> <maml:uri /> <maml:description> <maml:para>Specifies types of sensors that can be created in PRTG.</maml:para> </maml:description> </dev:type> <dev:defaultValue>ExeXml</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">ExeXml</command:parameterValue> <command:parameterValue required="false" variableLength="false">WmiService</command:parameterValue> <command:parameterValue required="false" variableLength="false">SqlServerDB</command:parameterValue> <command:parameterValue required="false" variableLength="false">Http</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: First --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>First</maml:name> <maml:description> <maml:para>The name to give the new sensor. If no value is specified, the default name of the specified sensor type will be used. If the specified sensor type does not support specifying a name, this field is used for any mandatory values required by the sensor type.</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: Second --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>Second</maml:name> <maml:description> <maml:para>A mandatory value required by the specified sensor type.</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: RawParameters --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>RawParameters</maml:name> <maml:description> <maml:para>A collection of raw parameters for adding an unsupported sensor type.</maml:para> </maml:description> <command:parameterValue required="true">Hashtable</command:parameterValue> <dev:type> <maml:name>System.Collections.Hashtable</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 create a set of DynamicSensorParameters from.</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: RawType --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>RawType</maml:name> <maml:description> <maml:para>The raw name of the sensor type to create.</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: Target --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Target</maml:name> <maml:description> <maml:para>Wildcard used to specify the sensor targets to assign to a set of DynamicSensorParameters.</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: Empty --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Empty</maml:name> <maml:description> <maml:para>Specifies that an empty set of RawSensorParameters should be returned to allow constructing a parameter set manually.</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.Device</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The device to create a set of DynamicSensorParameters from.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>C:\> $params = New-SensorParameters ExeXml "Custom Script" "CustomScript.ps1"</dev:code> <dev:remarks> <maml:para>C:\> Get-Device dc-1 | Add-Sensor $params</maml:para> <maml:para>Create a new EXE/Script Advanced sensor on the device dc-1 using the name "Custom Script", that executes the file "CustomScript.ps1", specifying the script name in the optional -Value parameter</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>C:\> $params = New-SensorParameters ExeXml "Custom Script"</dev:code> <dev:remarks> <maml:para>C:\> $params.ExeFile = "CustomScript.ps1"</maml:para> <maml:para>C:\> Get-Device dc-1 | Add-Sensor $params</maml:para> <maml:para>Create a new EXE/Script Advanced sensor on the device dc-1 using the name "Custom Script", that executes the file "CustomScript.ps1", specifying the script name after the object has been created</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 3 ----------</maml:title> <dev:code>C:\> $params = New-SensorParameters ExeXml</dev:code> <dev:remarks> <maml:para>C:\> $params.ExeFile = "CheckStatus.ps1"</maml:para> <maml:para>C:\> Get-Device -Id 1001 | Add-Sensor $params</maml:para> <maml:para>Create a new EXE/Script Advanced sensor on the device with ID 1001 using the name "XML Custom EXE/Script Sensor" that executes the file "CheckStatus.ps1"</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 4 ----------</maml:title> <dev:code>C:\> $params = Get-Device esxi-1 | New-SensorParameters -RawType vmwaredatastoreextern</dev:code> <dev:remarks> <maml:para>C:\> $params.datafieldlist__check = $params.Targets["datafieldlist__check"]</maml:para> <maml:para>C:\> $params | Add-Sensor</maml:para> <maml:para>Dynamically create a new set of VMware Datastore credentials for the device named esxi-1 targeting all datastores that exist on the device.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 5 ----------</maml:title> <dev:code>C:\ $params = Get-Device esxi-1 | New-SensorParameters -RawType vmwaredatastoreextern</dev:code> <dev:remarks> <maml:para>C:\> $params[[PrtgAPI.Parameter]::Custom]</maml:para> <maml:para>View the raw set of CustomParameters defined on an object.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 6 ----------</maml:title> <dev:code>C:\> $params = Get-Device esxi-1 | New-SensorParameters -RawType exchangepsdatabase</dev:code> <dev:remarks> <maml:para>C:\> $params.Unlock()</maml:para> <maml:para>C:\> $params.customparam_ = "some value"</maml:para> <maml:para>Create a new parameter named "customparam" on a set of Exchange Database sensor parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 7 ----------</maml:title> <dev:code>C:\> $params = New-SensorParameters -Empty</dev:code> <dev:remarks> <maml:para>C:\> $params["name_"] = "My Sensor"</maml:para> <maml:para>C:\> $params["sensortype"] = "exexml"</maml:para> <maml:para>Create an empty set of sensor parameters to manually insert all raw parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 8 ----------</maml:title> <dev:code>C:\> $raw = @{</dev:code> <dev:remarks> <maml:para>>> name_ = "my raw sensor"</maml:para> <maml:para>>> tags_ = "xmlexesensor"</maml:para> <maml:para>>> priority_ = 4</maml:para> <maml:para>>> exefile_ = "CustomScript.ps1|CustomScript.ps1||</maml:para> <maml:para>>> exeparams_ = "arg1 arg2 arg3"</maml:para> <maml:para>>> environment_ = 1</maml:para> <maml:para>>> usewindowsauthentication_ = 1</maml:para> <maml:para>>> mutexname_ = "testMutex"</maml:para> <maml:para>>> timeout_ = 70</maml:para> <maml:para>>> writeresult_ = 1</maml:para> <maml:para>>> intervalgroup = 0</maml:para> <maml:para>>> interval_ = "30|30 seconds"</maml:para> <maml:para>>> errorintervalsdown_ = 2</maml:para> <maml:para>>> sensortype = "exexml"</maml:para> <maml:para>>> }</maml:para> <maml:para>C:\> $params = New-SensorParameters $raw</maml:para> <maml:para>C:\> Get-Device dc-1 | Add-Sensor $params</maml:para> <maml:para>Add a new EXE/Script Advanced sensor to the device named dc-1 using a hashtable containing its raw parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 9 ----------</maml:title> <dev:code>C:\> Set-StrictMode -Version 3</dev:code> <dev:remarks> <maml:para>Set the Strict Mode to version 3 for the current PowerShell session.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Get-Help SensorParameters</maml:linkText> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Add-Sensor</maml:linkText> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-Device</maml:linkText> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-StrictMode</maml:linkText> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Get-SensorTarget --> <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-SensorTarget</command:name> <command:verb>Get</command:verb> <command:noun>SensorTarget</command:noun> <maml:description> <maml:para>Retrieves system resources that capable of being monitored or used for monitoring by a new PRTG Sensor.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Get-SensorTarget cmdlet identifies resources that are capable of being used as the target of a new PRTG Sensor. The resources identified by Get-SensorTarget are dynamic in nature. When Get-SensorTarget is executed, the PRTG will interrogate the PRTG Probe of the specified device in order to identify the resources that are compatible with the target system. For example, for creating a new WMI Service sensor, PRTG will request the probe enumerate all of the system services that are installed on the target device.</maml:para> <maml:para>For convenience, Get-SensorTarget allows specifying a -Name used to filter the returned results. Typically, items returned by Get-SensorTarget should be sent straight to a call to New-SensorParameters, however if you do not wish to perform any other processing on the results returned by this cmdlet you may automatically generate a set of parameters for the specified sensor type by specifying the -Parameters (alias: -Params) parameter. When creating sensor parameters with the -Params parameter, the default sensor name of the specified sensor type will be used.</maml:para> <maml:para>Sensor types not supported by PrtgAPI can still be interrogated by Get-SensorTarget via the -RawType parameter. Raw sensor type names can be found by inspecting the Id column of items output from the Get-SensorType cmdlet. When operating on raw types, by default Get-SensorTarget will attempt to guess the name of the data table within PRTG the sensor targets are stored in. If PRTG detects more than one data table exists, an ArgumentException will be thrown listing the names of all of the available tables. The name of the table to use can then be specified to the -Table parameter.</maml:para> <maml:para>Sensor targets identified for raw types are represented as a "generic" sensor target type. Generic sensor targets allow accessing both their Name and Value as named properties. Any other properties of the sensor target can be obtained by accessing the Properties array of the object. Generic sensor targets capable of being used with any NewSensorParameters type, including RawSensorParameters and DynamicSensorParameters.</maml:para> <maml:para>While resources returned by Get-SensorTarget are guaranteed to be compatible with the target device, there is no restriction preventing such resources from being used on other devices as well. Attempting to create a sensor on an incompatible device may succeed, however the sensor will likely enter a Down state upon refreshing, similar to what would happen if the sensor were created normally and then the sensor's target was deleted.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: DefaultSet --> <command:syntaxItem> <maml:name>Get-SensorTarget</maml:name> <!-- Parameter: Type --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>Type</maml:name> <maml:description> <maml:para>The type of sensor target to query for. Not all sensor types may require or support target resolution.</maml:para> <maml:para>Possible values: ExeXml, WmiService, SqlServerDB, Http</maml:para> </maml:description> <command:parameterValue required="true">SensorType</command:parameterValue> <dev:type> <maml:name>PrtgAPI.SensorType</maml:name> <maml:uri /> <maml:description> <maml:para>Specifies types of sensors that can be created in PRTG.</maml:para> </maml:description> </dev:type> <dev:defaultValue>ExeXml</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">ExeXml</command:parameterValue> <command:parameterValue required="false" variableLength="false">WmiService</command:parameterValue> <command:parameterValue required="false" variableLength="false">SqlServerDB</command:parameterValue> <command:parameterValue required="false" variableLength="false">Http</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: Name --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>An expression used to filter returned results to those with a specified 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: Device --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Device</maml:name> <maml:description> <maml:para>The device to retrieve sensor targets from. While results returned by Get-SensorTarget are guaranteed to be compatible with the specified device, returned objects may also be compatible with other devices in PRTG.</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: Parameters --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="Params"> <maml:name>Parameters</maml:name> <maml:description> <maml:para>When present, specifies that Get-SensorTarget should automatically wrap the returned items up in a set of sensor parameters applicable to the specified sensor type.</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> <!-- Parameter set: RawSet --> <command:syntaxItem> <maml:name>Get-SensorTarget</maml:name> <!-- Parameter: Name --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>An expression used to filter returned results to those with a specified 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: Device --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Device</maml:name> <maml:description> <maml:para>The device to retrieve sensor targets from. While results returned by Get-SensorTarget are guaranteed to be compatible with the specified device, returned objects may also be compatible with other devices in PRTG.</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: RawType --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>RawType</maml:name> <maml:description> <maml:para>The raw type of sensor target to query for. Types that require additional information before querying (such as Oracle Tablespace) cannot be queried.</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: Table --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Table</maml:name> <maml:description> <maml:para>The name of the Dropdown List or Checkbox Group the sensor targets belong to. If this value is null, PrtgAPI will attempt to guess the name of the table. If this value cannot be guessed or is not valid, an ArgumentException will be thrown listing all possible values.</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="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Device</maml:name> <maml:description> <maml:para>The device to retrieve sensor targets from. While results returned by Get-SensorTarget are guaranteed to be compatible with the specified device, returned objects may also be compatible with other devices in PRTG.</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: Type --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>Type</maml:name> <maml:description> <maml:para>The type of sensor target to query for. Not all sensor types may require or support target resolution.</maml:para> <maml:para>Possible values: ExeXml, WmiService, SqlServerDB, Http</maml:para> </maml:description> <command:parameterValue required="true">SensorType</command:parameterValue> <dev:type> <maml:name>PrtgAPI.SensorType</maml:name> <maml:uri /> <maml:description> <maml:para>Specifies types of sensors that can be created in PRTG.</maml:para> </maml:description> </dev:type> <dev:defaultValue>ExeXml</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">ExeXml</command:parameterValue> <command:parameterValue required="false" variableLength="false">WmiService</command:parameterValue> <command:parameterValue required="false" variableLength="false">SqlServerDB</command:parameterValue> <command:parameterValue required="false" variableLength="false">Http</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: Name --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>An expression used to filter returned results to those with a specified 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: Parameters --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="Params"> <maml:name>Parameters</maml:name> <maml:description> <maml:para>When present, specifies that Get-SensorTarget should automatically wrap the returned items up in a set of sensor parameters applicable to the specified sensor type.</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:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="Params"> <maml:name>Params</maml:name> <maml:description> <maml:para>When present, specifies that Get-SensorTarget should automatically wrap the returned items up in a set of sensor parameters applicable to the specified sensor type.</maml:para> <maml:para>This is an alias of the Parameters parameter.</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: RawType --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>RawType</maml:name> <maml:description> <maml:para>The raw type of sensor target to query for. Types that require additional information before querying (such as Oracle Tablespace) cannot be queried.</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: Table --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Table</maml:name> <maml:description> <maml:para>The name of the Dropdown List or Checkbox Group the sensor targets belong to. If this value is null, PrtgAPI will attempt to guess the name of the table. If this value cannot be guessed or is not valid, an ArgumentException will be thrown listing all possible values.</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.Device</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The device to retrieve sensor targets from. While results returned by Get-SensorTarget are guaranteed to be compatible with the specified device, returned objects may also be compatible with other devices in PRTG.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>C:\> $device = Get-Device -Id 1001</dev:code> <dev:remarks> <maml:para>C:\> $services = Get-SensorTarget WmiService *exchange*</maml:para> <maml:para>C:\> $params = New-SensorParameters WmiService $services</maml:para> <maml:para>C:\> $device | Add-Sensor $params</maml:para> <maml:para>Add all WMI Services whose name contains "Exchange" to 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:\> $device = Get-Device -Id 1001</dev:code> <dev:remarks> <maml:para>C:\> $params = $device | Get-SensorTarget WmiService *exchange* -Params</maml:para> <maml:para>C:\> $device | Add-Sensor $params</maml:para> <maml:para>Add all WMI Services whose name contains "Exchange" to the Device with ID 1001, creating sensor parameters immediately.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 3 ----------</maml:title> <dev:code>C:\> $targets = Get-Device -Id 1001 | Get-SensorTarget -RawType vmwaredatastoreextern</dev:code> <dev:remarks> <maml:para>Get all VMware Datastores from the device with ID 1001.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 4 ----------</maml:title> <dev:code>C:\> $targets = Get-Device -Id 1001 | Get-SensorTarget -RawType wmivolume</dev:code> <dev:remarks> <maml:para>C:\> $targets | foreach { $_.Properties[3] }</maml:para> <maml:para>List the disk type (Local Disk, Compact Disk etc) of all WMI Volume targets.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>New-SensorParameters</maml:linkText> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Add-Sensor</maml:linkText> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-Device</maml:linkText> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-SensorType</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> <maml:description> <maml:para>Indicates the total number of each type of sensor on a PRTG Server.</maml:para> </maml:description> </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: Get-SensorType --> <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-SensorType</command:name> <command:verb>Get</command:verb> <command:noun>SensorType</command:noun> <maml:description> <maml:para>Retrieves all sensor types supported by a PRTG Server.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Get-SensorType cmdlet retrieves all sensor types from PRTG that are supported by a specified object, allowing you to identify the Type Id to be used with other cmdlets (such as Get-SensorTarget and New-SensorParameters). If no -Object is specified, by default Get-SensorType will retrieve sensor types supported by the Core Probe (Object ID: 1). Practically speaking, all objects appear to support all sensor types; as such, there should generally be no need to specify an - Object.</maml:para> <maml:para>Results returned by Get-SensorType can be filtered by specifying an expression to the -Name parameter. Sensor type results will be filtered to those that contain the specified expression anywhere in either the Id, Name or Description.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Get-SensorType</maml:name> <!-- Parameter: Name --> <command:parameter required="false" globbing="false" pipelineInput="false" position="0"> <maml:name>Name</maml:name> <maml:description> <maml:para>Filters results to those that contain the specified expression in any field.</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="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Object</maml:name> <maml:description> <maml:para>The object to retrieve sensor types from. If no object is specified, PrtgAPI will retrieve all types supported by the Core Probe (ID 1)</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>Base class for Devices, Groups and Probes, containing properties that apply to all three object types.</maml:para> </maml:description> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Object --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Object</maml:name> <maml:description> <maml:para>The object to retrieve sensor types from. If no object is specified, PrtgAPI will retrieve all types supported by the Core Probe (ID 1)</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>Base class for Devices, Groups and Probes, containing properties that apply to all three object types.</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>Filters results to those that contain the specified expression in any field.</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.DeviceOrGroupOrProbe</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The object to retrieve sensor types from. If no object is specified, PrtgAPI will retrieve all types supported by the Core Probe (ID 1)</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>C:\> Get-SensorType</dev:code> <dev:remarks> <maml:para>List all sensor types supported by PRTG.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>C:\> Get-SensorType *exchange*</dev:code> <dev:remarks> <maml:para>List all sensor types that contain "exchange" in the Id, Name or Description.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 3 ----------</maml:title> <dev:code>C:\> Get-Device -Id 1001 | Get-SensorType</dev:code> <dev:remarks> <maml:para>List all sensor types supported by the Device with Id 1001</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Get-SensorTarget</maml:linkText> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-SensorParameters</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> <maml:description> <maml:para>The Sort-PrtgObject cmdlet sorts the children of a specified object alphabetically. In addition to normal devices, groups and probes, this cmdlet can also be used against the Root group (ID: 0), allowing you to sort probes alphabetically as well.</maml:para> </maml:description> <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>Base class for Devices, Groups and Probes, containing properties that apply to all three object types.</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: PassThru --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PassThru</maml:name> <maml:description> <maml:para>Specifies whether to return the original PrtgObject that was passed to this cmdlet, allowing the object to be further piped into additional cmdlets.</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 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>Base class for Devices, Groups and Probes, containing properties that apply to all three object types.</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: PassThru --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PassThru</maml:name> <maml:description> <maml:para>Specifies whether to return the original PrtgObject that was passed to this cmdlet, allowing the object to be further piped into additional cmdlets.</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.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> <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:relatedLinks> </command:command> </helpItems> |