< Back

VolumeSize

Sun Jan 19, 2020 5:48 pm

NAME VolumeSize



SYNOPSIS

Generates a <VolumeSize></VolumeSize> XML tag for specifying the scaling factor of a channel value's volume in a

custom PRTG Network Monitor EXE/XML Sensor.





SYNTAX

VolumeSize [[-Value] <String>] [<CommonParameters>]





DESCRIPTION

The VolumeSize tag specifies the volume scaling factor a channel Value has been specified in.



When the channel Mode is Absolute (the default), the VolumeSize refers to the scaling factor of the value that

will appear in the "Last Value" column of a sensor.



When defining a channel where the Mode is Difference, VolumeSize specifies the scaling factor of the channel Value

that applies to the "Last Value (volume)" column, while SpeedSize specifies the scaling factor of the value that

applies to the "Last Value (speed)" column.



As all channels default to Absolute Mode by default, unless a Mode has been explicitly specified the VolumeSize

property should always be used over the SpeedSize property.





PARAMETERS

-Value <String>

The scaling factor the channel value has been specified in.



Required? false

Position? 0

Default value None

Accept pipeline input? False

Accept wildcard characters? false



<CommonParameters>

This cmdlet supports the common parameters: Verbose, Debug,

ErrorAction, ErrorVariable, WarningAction, WarningVariable,

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

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



INPUTS



OUTPUTS



NOTES









-------------------------- Example 1 --------------------------



Prtg {

Result {

Channel "My channel"

Value 1000

Unit TimeSeconds

VolumeSize Kilo

}

}



Create a sensor with a value of 1s (1000/Kilo = 1000/1000 = 1).



RELATED LINKS

Online Version: https://github.com/lordmilko/PrtgXml/bl ... umeSize.md

Prtg

Result

Value

SpeedSize

Mode

Unit