< Back
Add-PRTGResult
Post
NAME Add-PRTGResult
SYNOPSIS
Creates a new PRTG Result Type
SYNTAX
Add-PRTGResult -Channel <String> -Value <Single> [-PRTGResultSet <Object>] [-PassThru] [-LimitMode] [-Warning]
[-ShowChart] [-ShowTable] [-NotifyChanged] [-Unit <String>] [-CustomUnit <String>] [-SpeedSize <String>]
[-SpeedTime <String>] [-Mode <String>] [-Float] [-DecimalMode <String>] [-LimitMaxError <Int32>] [-LimitMinError
<Int32>] [-LimitErrorMsg <String>] [-LimitMaxWarning <Int32>] [-LimitMinWarning <Int32>] [-LimitWarningMsg
<String>] [<CommonParameters>]
Add-PRTGResult -Channel <String> -Value <Single> [-PRTGResultSet <Object>] [-PassThru] [-LimitMode] [-Warning]
[-ShowChart] [-ShowTable] [-NotifyChanged] -ValueLookup <String> [<CommonParameters>]
DESCRIPTION
This command creates a new PRTG result
PARAMETERS
-Channel <String>
The name for the sensor channel
Required? true
Position? named
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-Value <Single>
The value as integer or float.
Required? true
Position? named
Default value 0
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-PRTGResultSet <Object>
A PRTG Result set created by New-PRTGResultSet
Required? false
Position? named
Default value
Accept pipeline input? true (ByValue)
Accept wildcard characters? false
-PassThru [<SwitchParameter>]
Pass through the final resultset (if not creating a new one)
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-LimitMode [<SwitchParameter>]
Define if the limit settings defined above will be active. Default is false (no; limits inactive). If 0 is
used the limits will be written to the sensor channel settings as predefined values, but limits will be
disabled.
Required? false
Position? named
Default value False
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-Warning [<SwitchParameter>]
If enabled for at least one channel, the entire sensor is set to "Warning" status. Default is false (no).
Required? false
Position? named
Default value False
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-ShowChart [<SwitchParameter>]
Init value for the Show in Graphs option. Default is 1 (yes). The values defined with this element will be
considered only on the first sensor scan, when the channel is newly created; they are ignored on all further
sensor scans (and may be omitted). You can change this initial setting later in the sensor's channel settings.
Required? false
Position? named
Default value False
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-ShowTable [<SwitchParameter>]
Init value for the Show in Tables option. Default is 1 (yes). The values defined with this element will be
considered only on the first sensor scan, when the channel is newly created; they are ignored on all further
sensor scans (and may be omitted). You can change this initial setting later in the sensor's channel settings.
Required? false
Position? named
Default value False
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-NotifyChanged [<SwitchParameter>]
If a returned channel contains this tag, it will trigger a change notification that you can use with the
Change Trigger to send a notification.
Required? false
Position? named
Default value False
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-ValueLookup <String>
The name of the value lookup ID to use. Defaults to simple 1 for true and 0 for false
Required? true
Position? named
Default value powershell.boolean
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-Unit <String>
The unit of the value. Default is Custom. This is useful for PRTG to be able to convert volumes and times.
NOTE: CPU is a percentage unit that is accounted to the CPU load in index graphs.
Required? false
Position? named
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-CustomUnit <String>
If Custom is used as unit, this is the text displayed behind the value. Use Any string (keep it short)
Required? false
Position? named
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-SpeedSize <String>
Size used for the display value. For example, if you have a value of 50000 and use Kilo as size, the display
is 50 kilo #.
Required? false
Position? named
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-SpeedTime <String>
In conjunction with SpeedSize, specify a duration. For instance, if you specify "Kilobit" for SpeedSize and
"Second" for this parameter, the unit will be kilobit per second
Required? false
Position? named
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-Mode <String>
Select if the value is an absolute value or counter. Default is Absolute.
Required? false
Position? named
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-Float [<SwitchParameter>]
Whether the value is a float or an integer. Set this to true if your result has a decimal point in it and is
not a whole number
Required? false
Position? named
Default value False
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-DecimalMode <String>
Init value for the Decimal Places option. If 0 is used in the <Float> element (use integer), the default is
Auto; otherwise (for float) the default is All.
Required? false
Position? named
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-LimitMaxError <Int32>
Define an upper error limit for the channel. If enabled, the sensor will be set to a "Down" status if this
value is overrun and the LimitMode is activated.
Required? false
Position? named
Default value 0
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-LimitMinError <Int32>
Define a lower error limit for the channel. If enabled, the sensor will be set to a "Down" status if this
value is undercut and the LimitMode is activated.
Required? false
Position? named
Default value 0
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-LimitErrorMsg <String>
Define an additional message. It will be added to the sensor's message when entering a "Down" status that is
triggered by a limit.
Required? false
Position? named
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-LimitMaxWarning <Int32>
Define an upper warning limit for the channel. If enabled, the sensor will be set to a "Warning" status if
this value is overrun and the LimitMode is activated.
Required? false
Position? named
Default value 0
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-LimitMinWarning <Int32>
Define a lower warning limit for the channel. If enabled, the sensor will be set to a "Warning" status if this
value is undercut and the LimitMode is activated.
Required? false
Position? named
Default value 0
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-LimitWarningMsg <String>
Define an additional message. It will be added to the sensor's message when entering a "Warning" status that
is triggered by a limit.
Required? false
Position? named
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
OUTPUTS
RELATED LINKS
SYNOPSIS
Creates a new PRTG Result Type
SYNTAX
Add-PRTGResult -Channel <String> -Value <Single> [-PRTGResultSet <Object>] [-PassThru] [-LimitMode] [-Warning]
[-ShowChart] [-ShowTable] [-NotifyChanged] [-Unit <String>] [-CustomUnit <String>] [-SpeedSize <String>]
[-SpeedTime <String>] [-Mode <String>] [-Float] [-DecimalMode <String>] [-LimitMaxError <Int32>] [-LimitMinError
<Int32>] [-LimitErrorMsg <String>] [-LimitMaxWarning <Int32>] [-LimitMinWarning <Int32>] [-LimitWarningMsg
<String>] [<CommonParameters>]
Add-PRTGResult -Channel <String> -Value <Single> [-PRTGResultSet <Object>] [-PassThru] [-LimitMode] [-Warning]
[-ShowChart] [-ShowTable] [-NotifyChanged] -ValueLookup <String> [<CommonParameters>]
DESCRIPTION
This command creates a new PRTG result
PARAMETERS
-Channel <String>
The name for the sensor channel
Required? true
Position? named
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-Value <Single>
The value as integer or float.
Required? true
Position? named
Default value 0
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-PRTGResultSet <Object>
A PRTG Result set created by New-PRTGResultSet
Required? false
Position? named
Default value
Accept pipeline input? true (ByValue)
Accept wildcard characters? false
-PassThru [<SwitchParameter>]
Pass through the final resultset (if not creating a new one)
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-LimitMode [<SwitchParameter>]
Define if the limit settings defined above will be active. Default is false (no; limits inactive). If 0 is
used the limits will be written to the sensor channel settings as predefined values, but limits will be
disabled.
Required? false
Position? named
Default value False
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-Warning [<SwitchParameter>]
If enabled for at least one channel, the entire sensor is set to "Warning" status. Default is false (no).
Required? false
Position? named
Default value False
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-ShowChart [<SwitchParameter>]
Init value for the Show in Graphs option. Default is 1 (yes). The values defined with this element will be
considered only on the first sensor scan, when the channel is newly created; they are ignored on all further
sensor scans (and may be omitted). You can change this initial setting later in the sensor's channel settings.
Required? false
Position? named
Default value False
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-ShowTable [<SwitchParameter>]
Init value for the Show in Tables option. Default is 1 (yes). The values defined with this element will be
considered only on the first sensor scan, when the channel is newly created; they are ignored on all further
sensor scans (and may be omitted). You can change this initial setting later in the sensor's channel settings.
Required? false
Position? named
Default value False
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-NotifyChanged [<SwitchParameter>]
If a returned channel contains this tag, it will trigger a change notification that you can use with the
Change Trigger to send a notification.
Required? false
Position? named
Default value False
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-ValueLookup <String>
The name of the value lookup ID to use. Defaults to simple 1 for true and 0 for false
Required? true
Position? named
Default value powershell.boolean
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-Unit <String>
The unit of the value. Default is Custom. This is useful for PRTG to be able to convert volumes and times.
NOTE: CPU is a percentage unit that is accounted to the CPU load in index graphs.
Required? false
Position? named
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-CustomUnit <String>
If Custom is used as unit, this is the text displayed behind the value. Use Any string (keep it short)
Required? false
Position? named
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-SpeedSize <String>
Size used for the display value. For example, if you have a value of 50000 and use Kilo as size, the display
is 50 kilo #.
Required? false
Position? named
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-SpeedTime <String>
In conjunction with SpeedSize, specify a duration. For instance, if you specify "Kilobit" for SpeedSize and
"Second" for this parameter, the unit will be kilobit per second
Required? false
Position? named
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-Mode <String>
Select if the value is an absolute value or counter. Default is Absolute.
Required? false
Position? named
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-Float [<SwitchParameter>]
Whether the value is a float or an integer. Set this to true if your result has a decimal point in it and is
not a whole number
Required? false
Position? named
Default value False
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-DecimalMode <String>
Init value for the Decimal Places option. If 0 is used in the <Float> element (use integer), the default is
Auto; otherwise (for float) the default is All.
Required? false
Position? named
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-LimitMaxError <Int32>
Define an upper error limit for the channel. If enabled, the sensor will be set to a "Down" status if this
value is overrun and the LimitMode is activated.
Required? false
Position? named
Default value 0
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-LimitMinError <Int32>
Define a lower error limit for the channel. If enabled, the sensor will be set to a "Down" status if this
value is undercut and the LimitMode is activated.
Required? false
Position? named
Default value 0
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-LimitErrorMsg <String>
Define an additional message. It will be added to the sensor's message when entering a "Down" status that is
triggered by a limit.
Required? false
Position? named
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-LimitMaxWarning <Int32>
Define an upper warning limit for the channel. If enabled, the sensor will be set to a "Warning" status if
this value is overrun and the LimitMode is activated.
Required? false
Position? named
Default value 0
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-LimitMinWarning <Int32>
Define a lower warning limit for the channel. If enabled, the sensor will be set to a "Warning" status if this
value is undercut and the LimitMode is activated.
Required? false
Position? named
Default value 0
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-LimitWarningMsg <String>
Define an additional message. It will be added to the sensor's message when entering a "Warning" status that
is triggered by a limit.
Required? false
Position? named
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
OUTPUTS
RELATED LINKS