ReportMagic

[LogicMonitor.DeviceList:]

The list of devices in the specified device group(s).

Purpose

Inserts a list of device names into your report, or to store them into a variable for later use in other macros. This works for device configurations that were present in LogicMonitor at the time the report was run.

Compatibility

The macro can be used in all input document types and in Report Studio.

Parameters (132)

Grouped View

Behaviour (1)11 additional

Parameter	Type	Presence	Purpose	Options	Default
recurseDeviceGroups	Boolean	Optional	Include devices in all child folders.	true false	true

Additional (11)

Parameter	Type	Presence	Purpose	Options	Default
calculate	String	Optional	Post processing formula. Use {value} for the macro output, e.g. {value}/1024.	N/A	N/A
errorOnOverflow	Boolean	Optional	Should NCalc expression evaluation throw error on Overflow	true false	true
fatalIf	String	Optional	The macro is considered 'fatal' if the expression evaluates to true. Use 'value' as the macro output in the expression.	N/A	N/A
hidden	Boolean	Optional	Whether to hide the macro output.	true false	false
if	String	Optional	The condition that must be true in order for the macro to be executed/evaluated. Must either evaluate to true or false, for example: "3+5=8" or "contains('abcd', 'z').	N/A	true
maxAttempts	Int32	Optional	The maximum number of attempts when requesting data via the LogicMonitor API.	From 1 to 2147483647	N/A
mode	MacroMode	Optional	The mode in which variables are stored. In the legacy mode (default for Schedules), the variable created is a string and formatted. In the normal mode (default for Report Studio), the output variable is stored as a strongly-typed theObject, e.g. an Int32 or a List etc., rather than a formatted string.	Legacy Normal	Legacy
obfuscation	ObfuscationType	Optional	Obfuscation type. Use obfuscation to write reports where sensitive data is hidden. When used, ReportMagic guarantees that the same input string will map to the same output string for the whole of the report (but the next time the report runs, it will most likely map to a different value). If you use obfuscation, the property in your macro will not show up and instead, you will see a fake item of the obfuscation type chosen.	None UkTown DeviceName Company IpAddress PrivateIpAddress	None
redact	Boolean	Optional	Whether substituted variables are hidden from macro results (and the word 'REDACTED' will appear in progress screens and elsewhere in the web UI).	true false	false
waitDuringUpgrades	Boolean	Optional	Whether to wait during LogicMonitor upgrades (i.e. execution essentially pauses).	true false	N/A
warning	String	Optional	If specified, adds a warning message for this macro. This is processed as an NCalc, and the warning message will ALWAYS be present and will be the value of the evaluated NCalc expression.	N/A	N/A

Colours (6)

Parameter	Type	Presence	Purpose	Options	Default
colorTableCell	Boolean	Optional	Whether to color table cells if thresholds are breached, rather than color the text.	true false	true
fontBackgroundColor	Color	Optional	The font background color to use.	A named color or an HTML-encoded color .Note that 'transparent' is a valid color that you can use in any macro parameter that expects a color.	N/A
fontColor	Color	Optional	The font color to use.	A named color or an HTML-encoded color .Note that 'transparent' is a valid color that you can use in any macro parameter that expects a color.	N/A
normalFontBackgroundColor	Color	Optional	The normal font background color to use. If omitted, no change is made.	A named color or an HTML-encoded color .Note that 'transparent' is a valid color that you can use in any macro parameter that expects a color.	N/A
normalFontColor	Color	Optional	The normal font color to use. If omitted, no change is made.	A named color or an HTML-encoded color .Note that 'transparent' is a valid color that you can use in any macro parameter that expects a color.	N/A
normalTableCellBackgroundColor	Color	Optional	The normal table cell background color to use. If omitted, no change is made.	A named color or an HTML-encoded color .Note that 'transparent' is a valid color that you can use in any macro parameter that expects a color.	N/A

Formatting (5)

Parameter	Type	Presence	Purpose	Options	Default
fontBold	Boolean	Optional	Change the font weight (true=strong, false=normal). If omitted, no change is made.	true false	N/A
fontSize	Double	Optional	Change the font size in points. If omitted, no change is made.	From 2 to 200	N/A
format	String	Optional	The formatting to use for numbers. You can also specify 'format=string' to force numbers to be treated as strings.	N/A	N/A
normalFontBold	Boolean	Optional	Change the normal font weight (true=strong, false=normal). If omitted, no change is made.	true false	N/A
normalFontSize	Double	Optional	Change the normal font size in points. If omitted, no change is made.	From 2 to 200	N/A

Conditional Formatting (69)

Parameter	Type	Presence	Purpose	Options	Default
criticalAfter	DateTimeOffset	Optional	The macro is considered 'critical' if the output is after this DateTime UTC.	N/A	N/A
criticalBefore	DateTimeOffset	Optional	The macro is considered 'critical' if the output is before this DateTime UTC.	N/A	N/A
criticalEq	String	Optional	The macro is considered 'critical' if the output is equal to this value.	N/A	N/A
criticalFontBackgroundColor	Color	Optional	The critical font background color to use. If omitted, no change is made.	A named color or an HTML-encoded color .Note that 'transparent' is a valid color that you can use in any macro parameter that expects a color.	N/A
criticalFontBold	Boolean	Optional	Change the font weight (true=strong, false=normal). If omitted, no change is made.	true false	N/A
criticalFontColor	Color	Optional	The critical font color to use. If omitted, no change is made.	A named color or an HTML-encoded color .Note that 'transparent' is a valid color that you can use in any macro parameter that expects a color.	N/A
criticalFontSize	Double	Optional	Change the critical font size in points. If omitted, no change is made.	From 2 to 200	N/A
criticalGe	String	Optional	The macro is considered 'critical' if the output is greater than or equal to this value.	N/A	N/A
criticalGt	String	Optional	The macro is considered 'critical' if the output is greater than this value.	N/A	N/A
criticalIf	String	Optional	The macro is considered 'critical' if the expression evaluates to true. Use 'value' as the macro output in the expression.	N/A	N/A
criticalLe	String	Optional	The macro is considered 'critical' if the output is less than or equal to this value.	N/A	N/A
criticalLt	String	Optional	The macro is considered 'critical' if the output is less than this value.	N/A	N/A
criticalNe	String	Optional	The macro is considered 'critical' if the output is not equal to this value.	N/A	N/A
criticalTableCellBackgroundColor	Color	Optional	The critical table cell background color to use.	A named color or an HTML-encoded color .Note that 'transparent' is a valid color that you can use in any macro parameter that expects a color.	N/A
errorAfter	DateTimeOffset	Optional	The macro is considered 'error' if the output is after this DateTime UTC.	N/A	N/A
errorBefore	DateTimeOffset	Optional	The macro is considered 'error' if the output is before this DateTime UTC.	N/A	N/A
errorEq	String	Optional	The macro is considered 'error' if the output is equal to this value.	N/A	N/A
errorFontBackgroundColor	Color	Optional	The error font background color to use. If omitted, no change is made.	A named color or an HTML-encoded color .Note that 'transparent' is a valid color that you can use in any macro parameter that expects a color.	N/A
errorFontBold	Boolean	Optional	Change the error font weight (true=strong, false=normal). If omitted, no change is made.	true false	N/A
errorFontColor	Color	Optional	The error font color to use. If omitted, no change is made.	A named color or an HTML-encoded color .Note that 'transparent' is a valid color that you can use in any macro parameter that expects a color.	N/A
errorFontSize	Double	Optional	Change the error font size in points. If omitted, no change is made.	From 2 to 200	N/A
errorGe	String	Optional	The macro is considered 'error' if the output is greater than or equal to this value.	N/A	N/A
errorGt	String	Optional	The macro is considered 'error' if the output is greater than this value.	N/A	N/A
errorIf	String	Optional	The macro is considered 'error' if the expression evaluates to true. Use 'value' as the macro output in the expression.	N/A	N/A
errorLe	String	Optional	The macro is considered 'error' if the output is less than or equal to this value.	N/A	N/A
errorLt	String	Optional	The macro is considered 'error' if the output is less than this value.	N/A	N/A
errorNe	String	Optional	The macro is considered 'error' if the output is not equal to this value.	N/A	N/A
errorTableCellBackgroundColor	Color	Optional	The error table cell background color to use.	A named color or an HTML-encoded color .Note that 'transparent' is a valid color that you can use in any macro parameter that expects a color.	N/A
fatalAfter	DateTimeOffset	Optional	The macro is considered 'fatal' if the output is after this DateTime UTC.	N/A	N/A
fatalBefore	DateTimeOffset	Optional	The macro is considered 'fatal' if the output is before this DateTime UTC.	N/A	N/A
fatalEq	String	Optional	The macro is considered 'fatal' if the output is equal to this value.	N/A	N/A
fatalFontBackgroundColor	Color	Optional	The fatal font background color to use. If omitted, no change is made.	A named color or an HTML-encoded color .Note that 'transparent' is a valid color that you can use in any macro parameter that expects a color.	N/A
fatalFontBold	Boolean	Optional	Change the fatal font weight (true=strong, false=normal). If omitted, no change is made.	true false	N/A
fatalFontColor	Color	Optional	The fatal font color to use. If omitted, no change is made.	A named color or an HTML-encoded color .Note that 'transparent' is a valid color that you can use in any macro parameter that expects a color.	N/A
fatalFontSize	Double	Optional	Change the fatal font size in points. If omitted, no change is made.	From 2 to 200	N/A
fatalGe	String	Optional	The macro is considered 'fatal' if the output is greater than or equal to this value.	N/A	N/A
fatalGt	String	Optional	The macro is considered 'fatal' if the output is greater than this value.	N/A	N/A
fatalLe	String	Optional	The macro is considered 'fatal' if the output is less than or equal to this value.	N/A	N/A
fatalLt	String	Optional	The macro is considered 'fatal' if the output is less than this value.	N/A	N/A
fatalNe	String	Optional	The macro is considered 'fatal' if the output is not equal to this value.	N/A	N/A
fatalTableCellBackgroundColor	Color	Optional	The fatal table cell background color to use.	A named color or an HTML-encoded color .Note that 'transparent' is a valid color that you can use in any macro parameter that expects a color.	N/A
infoAfter	DateTimeOffset	Optional	The macro is considered 'info' if the output is after this DateTime UTC.	N/A	N/A
infoBefore	DateTimeOffset	Optional	The macro is considered 'info' if the output is before this DateTime UTC.	N/A	N/A
infoEq	String	Optional	The macro is considered 'info' if the output is equal to this value.	N/A	N/A
infoFontBackgroundColor	Color	Optional	The info font background color to use. If omitted, no change is made.	A named color or an HTML-encoded color .Note that 'transparent' is a valid color that you can use in any macro parameter that expects a color.	N/A
infoFontBold	Boolean	Optional	Change the info font weight (true=strong, false=normal). If omitted, no change is made.	true false	N/A
infoFontColor	Color	Optional	The info font color to use. If omitted, no change is made.	A named color or an HTML-encoded color .Note that 'transparent' is a valid color that you can use in any macro parameter that expects a color.	N/A
infoFontSize	Double	Optional	Change the info font size in points. If omitted, no change is made.	From 2 to 200	N/A
infoGe	String	Optional	The macro is considered 'info' if the output is greater than or equal to this value.	N/A	N/A
infoGt	String	Optional	The macro is considered 'info' if the output is greater than this value.	N/A	N/A
infoIf	String	Optional	The macro is considered 'info' if the expression evaluates to true. Use 'value' as the macro output in the expression.	N/A	N/A
infoLe	String	Optional	The macro is considered 'info' if the output is less than or equal to this value.	N/A	N/A
infoLt	String	Optional	The macro is considered 'info' if the output is less than this value.	N/A	N/A
infoNe	String	Optional	The macro is considered 'info' if the output is not equal to this value.	N/A	N/A
infoTableCellBackgroundColor	Color	Optional	The info table cell background color to use.	A named color or an HTML-encoded color .Note that 'transparent' is a valid color that you can use in any macro parameter that expects a color.	N/A
warningAfter	DateTimeOffset	Optional	The macro is considered 'warning' if the output is after this DateTime UTC.	N/A	N/A
warningBefore	DateTimeOffset	Optional	The macro is considered 'warning' if the output is before this DateTime UTC.	N/A	N/A
warningEq	String	Optional	The macro is considered 'warning' if the output is equal to this value.	N/A	N/A
warningFontBackgroundColor	Color	Optional	The warning font background color to use. If omitted, no change is made.	A named color or an HTML-encoded color .Note that 'transparent' is a valid color that you can use in any macro parameter that expects a color.	N/A
warningFontBold	Boolean	Optional	Change the warning font weight (true=strong, false=normal). If omitted, no change is made.	true false	N/A
warningFontColor	Color	Optional	The warning font color to use. If omitted, no change is made.	A named color or an HTML-encoded color .Note that 'transparent' is a valid color that you can use in any macro parameter that expects a color.	N/A
warningFontSize	Double	Optional	Change the warning font size in points. If omitted, no change is made.	From 2 to 200	N/A
warningGe	String	Optional	The macro is considered 'warning' if the output is greater than or equal to this value.	N/A	N/A
warningGt	String	Optional	The macro is considered 'warning' if the output is greater than this value.	N/A	N/A
warningIf	String	Optional	The macro is considered 'warning' if the expression evaluates to true. Use 'value' as the macro output in the expression.	N/A	N/A
warningLe	String	Optional	The macro is considered 'warning' if the output is less than or equal to this value.	N/A	N/A
warningLt	String	Optional	The macro is considered 'warning' if the output is less than this value.	N/A	N/A
warningNe	String	Optional	The macro is considered 'warning' if the output is not equal to this value.	N/A	N/A
warningTableCellBackgroundColor	Color	Optional	The warning table cell background color to use.	A named color or an HTML-encoded color .Note that 'transparent' is a valid color that you can use in any macro parameter that expects a color.	N/A

Filtering & Sorting (6)

Parameter	Type	Presence	Purpose	Options	Default
filter	String	Optional	For advanced filtering, use the LogicMonitor API's filtering system. This feature is only supported through professional services.	N/A	N/A
filterProperty	String	Optional	Specify the property that you want to filter on, e.g. system.sysinfo. If filterProperty is set, filterPropertyValue is mandatory.	N/A	N/A
filterPropertyValue	TildaOptionString	Optional	specify the value that you want to filter on, e.g. Microsoft Windows Server 2008 R2 Standard. May be specified as "filterPropertyValue=value" to match all devices where the specified property equals 'value', or "filterPropertyValue~=value" to match all devices where the specified property contains 'value'. Ignored if filterProperty is not set.	N/A	N/A
matchAppliesToQuery	String	Optional	Only include devices that match this LogicMonitor AppliesTo query. For example, "isCisco()" for Cisco devices. See LogicMonitor documentation for more details. Use backticks to surround the query, instead of double quotes. Note that if you reference a custom property in the query and that property name includes special characters (such as :, /, *, = or spaces) then you will need to use the getPropValue("") function instead of just referencing the property. See our examples.	N/A	N/A
orderBy	DeviceProperty	Optional	Order by this Device property.	DisplayName AllAsJson Id Link HostName NetflowCollectorId PreferredCollectorId CollectorDescription EnableNetflow DisplayedAs Type AlertStatus Status AlertsAreAcknowledged AlertLevel AlertsAreInSdt DeviceGroupIds CurrentCollectorId AlertEnable AutoPropsAssignedOn AutoPropsUpdatedOn CreatedOn EffectiveAlertEnabled DeviceGroups Groups InSdt SdtStatus LastDataTime DeviceStatus AllAsJObject	DisplayName
selectDistinct	Boolean	Optional	Eliminate duplicates if set to true.	true false	false

Output (1)7 additional

Parameter	Type	Presence	Purpose	Options	Default
delimiter	Char	Optional	The delimiter to use between multiple items in the output.	N/A	;

Additional (7)

Parameter	Type	Presence	Purpose	Options	Default
failureText	String	Optional	The text to display should the macro fail to execute. Note that a poorly-specified macro (e.g. omitting mandatory parameters) will still result in an error message.	N/A	N/A
failureVariable	String	Optional	The name of a variable to create should the macro fail to execute. The variable will be a text variable, and will contain either the failure text (only if the failureText parameter is set), otherwise it will contain the exception / failure message.	N/A	N/A
outputListsAsJarray Normal mode	Boolean	Optional	Any macros that output lists can optionally (in Normal mode) output a jArray instead.	true false	true
storeAs	String	Optional	The variable to store the result as.	N/A	N/A
storeAsHidden	String	Optional	The variable to store the result as, while hiding the output. Equivalent to 'storeAs=ThisValue, hidden=true'.	N/A	N/A
storeAsVariableDelimiter	Char	Optional	The delimiter used by storeAs to split the input (Legacy mode only), when there are multiple stored variables. For example, in this macro, we indicate that the value to be stored should be split by the asterisk when being stored: [String:value=abcd, storeAs=var1;var2;var3;var4, storeAsVariableDelimiter=]	N/A	;
storeFormattedValueAs	String	Optional	The name of the STRING variable to store the result as and output (both will use the same format) into the report. Note that if you also use 'storeAsHidden' in the same macro, you should not expect the output to be hidden, as this parameter overrides that.	N/A	N/A

General (16)6 additional

Parameter	Type	Presence	Purpose	Options	Default
createdBefore	DateTimeOffset	Optional	Only include devices that were created before this time (UTC).	N/A	N/A
dataSourceExists	String	Optional	The name of the DataSource that you want to filter by, i.e. only include devices that have this DataSource. One or more DataSource instances must be present on this device for it to be included, unless an instanceCount parameter is specified (e.g. instanceCountGe=0). Please note that there is a significant performance overhead associated with using this parameter.	N/A	N/A
dataSourceInstanceAlias	String	Optional	The DataSource instance alias that you want to filter by i.e. only include devices that have this DataSource instance alias present. When set, dataSourceExists is mandatory.	N/A	N/A
dataSourceInstanceGroupName	String	Optional	The DataSource instance group that you want to filter by i.e. only include devices that have this DataSource Instance Group name present. When set, dataSourceExists is mandatory.	N/A	N/A
dataSourceInstanceName	String	Optional	The DataSource instance alias that you want to filter by i.e. only include devices that have this DataSource instance name present. When set, dataSourceExists is mandatory.	N/A	N/A
deviceGroup	List<String>	Optional	The Device Group or Device Groups (semi-colon separated). Use "/" or no value to reference the root folder.	N/A	/
instanceCountEq	Int32	Optional	Only include the devices where the number of matching instances is equal to the integer value specified. Applies when dataSourceExists is used.	N/A	N/A
instanceCountGe	Int32	Optional	Only include the devices where the number of matching instances is greater than or equal to the integer value specified. Applies when dataSourceExists is used.	N/A	N/A
instanceCountGt	Int32	Optional	Only include the devices where the number of matching instances is greater than the integer value specified. Applies when dataSourceExists is used.	N/A	N/A
instanceCountLe	Int32	Optional	Only include the devices where the number of matching instances is less than or equal to the integer value specified. Applies when dataSourceExists is used.	N/A	N/A
instanceCountLt	Int32	Optional	Only include the devices where the number of matching instances is less than the integer value specified. Applies when dataSourceExists is used.	N/A	N/A
instanceCountNe	Int32	Optional	Only include the devices where the number of matching instances is not equal to the integer value specified. Applies when dataSourceExists is used.	N/A	N/A
isAlertingEnabled	Boolean	Optional	When specified only brings back DeviceGroups where the alerting is/is not enabled	true false	N/A
property	String	Optional	Return the specified property. May be one of the following or any custom device property: AlertEnable AllAsJson AutopropsAssignedOn AutopropsUpdatedOn CreatedOn DevicegroupIds DisplayedAs DisplayName EffectiveAlertEnabled EnableNetflow HostName Id InSdt SdtStatus LastDataTime Link AlertStatus Status Type	N/A	DisplayName
status	String	Optional	Only include devices in this status. Supported values: Dead and Normal.	N/A	N/A
type	DeviceListType	Optional	Whether to include Devices, Services, or both.	Device Service All	Device

Additional (6)

Parameter	Type	Presence	Purpose	Options	Default
comment	String	Optional	Add a comment to make your document template more readable. The comment is discarded in the output document.	N/A	N/A
connectionName	String	Optional	The name of the LogicMonitor Connection.	N/A	N/A
desiredExecutionResult	ExecutionResult	Optional	If specified, asserts the expected execution result of the macro. The macro executes normally; if the actual result matches the desired value, the result is converted to Success. If the actual result does not match, the result is converted to MacroError with a descriptive message. This is primarily used for testing and diagnostic purposes. Valid values are: Unknown, Success, MacroError, WorkerStopped, Running, Warning, NeverRun, Cancelled, Pending, Paused, SystemError, Deferred, Stopped.	Cancelled Deferred MacroError NeverRun Paused Pending Running Stopped Success SystemError Warning WorkerStopped	N/A
expectedType	String	Optional	If specified, asserts the expected output type of the macro result. The macro executes normally; if the actual type does not match, a macro error is generated. Requires 'storeAs', 'storeAsHidden', or 'storeFormattedValueAs' to be set for typed validation. Valid types include CLR names (e.g. Int32, Int64, Single, Double, Boolean, String, JArray, JObject) and C# keyword aliases (e.g. int, long, float, double, bool, string, uint, ulong, short, ushort, byte, sbyte, decimal, char, object). The special value 'Number' matches any numeric type.	N/A	N/A
expectedValue	String	Optional	If specified, asserts the expected output value of the macro result. The macro executes normally; if the actual value does not match, a macro error is generated. When 'storeAs' or 'storeAsHidden' is set, the stored variable value is compared. Otherwise, the document output text is compared.	N/A	N/A
singleValueList Normal mode	Boolean	Optional	In Normal Mode and for macros that output JArrays only, whether to convert a JArray of single-property jObjects into a flat JArray of values.	true false	false

Deprecated (4)

Parameter	Type	Preferred Parameter	Purpose	Options	Default
deviceGroups	List<String>	deviceGroup	The Device Group or Device Groups (semi-colon separated). Use "/" or no value to reference the root folder.	N/A	/
group	List<String>	deviceGroup	The Device Group or Device Groups (semi-colon separated). Use "/" or no value to reference the root folder.	N/A	/
groups	List<String>	deviceGroup	The Device Group or Device Groups (semi-colon separated). Use "/" or no value to reference the root folder.	N/A	/
recurseDeviceGroup	Boolean	recurseDeviceGroups	Include devices in all child folders.	true false	true

Examples (6)

Example 1

Lists Devices in two Device Groups:

[LogicMonitor.DeviceList: deviceGroups=PDL - Panoramic Data/Datacenter/Public, storeAsHidden=myDevices][String: value={myDevices}]

Example 2

Lists Devices in two Device Groups that use the WinCPU DataSource:

[LogicMonitor.DeviceList: deviceGroups=PDL - Panoramic Data/Datacenter/Public;PDL - Panoramic Data/Datacenter/Private, storeAsHidden=myDevices, property=DisplayedAs, dataSourceExists=WinCPU, selectDistinct=true][String: value={myDevices}]

Example 3

Lists Devices in two Device Groups that use the WinCriticalServices DataSource, which has more than one instance:

[LogicMonitor.DeviceList: deviceGroups=PDL - Panoramic Data/Datacenter/Public;PDL - Panoramic Data/Datacenter/Private, storeAsHidden=myDevices, property=DisplayedAs, dataSourceExists=WinCriticalServices, selectDistinct=true, instanceCountGt=1][String: value={myDevices}]

Example 4

Lists Devices in two Device Groups that have the property system.enablenetflow set to true:

[LogicMonitor.DeviceList: deviceGroups=PDL - Panoramic Data/Datacenter/Public;PDL - Panoramic Data/Datacenter/Private, property=DisplayedAs, filterProperty=system.enablenetflow, filterPropertyValue=true]

Example 5

Lists all Cisco Devices in the entire portal:

[LogicMonitor.DeviceList: deviceGroups=/, recurseDeviceGroups=true, matchAppliesToQuery=isCisco()]

Example 6

Lists all Devices that have the custom property thing1:thing2 (note the special character ':' means that we must use LogicMonitor's getPropValue function):

[LogicMonitor.DeviceList: property=DisplayedAs, matchAppliesToQuery=`getPropValue("thing1:thing2")`]