ReportMagic

[LogicMonitor.DeviceGroupList:]UPDATED

Inserts a list of Device Groups, or Services within a Service Group.

Purpose

Inserts a list of Device Groups, or Services within a Service Group. This lists Device Groups / Services that were present in LogicMonitor at the time the report was run.

Macro Compatibility

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

Usage

Note: when a non-existent Device Group(s) is specified with the deviceGroups parameter, you may receive an empty list. Optionally, use 'checkDeviceGroupsExist=true' to validate them first (executes slightly slower, but in this case generates an error extremely quickly).

What's New

(2025-06-02)

The 'OrderBy' and 'OrderByDescending' parameters now work in Normal Mode.

Parameter	Type	Deprecation Message	Preferred Parameter	Presence	Purpose	Options	Default
calculate	String			Optional	Post processing formula. Use {value} for the macro output, e.g. {value}/1024.	N/A	N/A
checkDeviceGroupsExist	Boolean			Optional	Specify true to check that the Device Groups exist before getting the list (for non-existent Device Groups, this will more quickly cause an error rather than an empty list). This does not apply to the root level, which always exists.	true false	false
colorTableCell	Boolean			Optional	Whether to color table cells if thresholds are breached, rather than color the text.	true false	true
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
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
delimiter	Char	Deprecated	listDelimiter		In Legacy Mode, the delimiter character to use between multiple items in the output.	N/A	;
deviceGroup	List<String>	Deprecated	resourceGroups		The Device Group (or semicolon-separated list of Device Groups). Use "/" or no value in the deviceGroup parameter to reference the root folder.	N/A	/
deviceGroups	List<String>	Deprecated	resourceGroups		The Device Group (or semicolon-separated list of Device Groups). Use "/" or no value in the deviceGroup parameter to reference the root folder.	N/A	/
deviceGroupType	DeviceGroupType			Optional	Filter the results by the type of Device Group.	All Dynamic Normal AwsWorkSpaceDirectorySubgroup AppStream AwsStepFunctions AwsCognito AwsElasticBeanstalkSubgroup AwsSageMaker AwsElasticTranscoder AwsRoute53Resolver AwsAppStream AwsAthena AwsOpsWorks AwsDocDB AwsEventBridge AwsAmazonMQ AwsGlue AwsMediaConnect AwsMediaStore AwsMediaConvert AwsMediaPackageLive AwsMediaPackageVOD AwsMediaTailor AwsRoot AwsCloudSearch AwsCodeBuild AwsEc2 AwsDmsReplicationTasks AwsDynamoDb AwsElastiCache AwsElb AwsEbs AwsSqs AwsRds AwsRoute53 AwsS3 AwsSns AwsAutoScaling AwsApiGateway AwsApplicationElb AwsFSx AwsKinesis AwsKinesisVideo AwsMSKBroker AwsMSKCluster AwsRedShift AwsTransitGateway AzureAzureRoot AzureAppService AzureSqlDatabase AzureVirtualMachine AwsCloudFront AzureEventHub AzureRedisCache VirtualMachineScaleSet VirtualMachineScaleSetVm AwsLambda AwsEcs AwsEfs AwsElasticsearch AwsSwfActivityType AwsSwfWorkflows AwsEmr AzureApplicationGateway AzureIotHub AzureServiceBus AzureFunction AzureVirtualMachineScaleSet AzureVirtualMachineScaleSetVm AzureVmScaleSetSubgroup AwsAutoscalingSubgroup AwsVpn AwsFirehose AwsSes AwsNetworkElb AwsWorkSpace AwsDirectConnect AzureSignalR AzureAnalysisService AzureTrafficManager AzureMySql AzurePostgreSql AzureStorageAccount AzureStorageAccountSubGroup AwsNatGateway AzureBlobStorage AzureFileStorage AzureQueueStorage AzureTableStorage AzureApiManagement AwsElasticBeanstalk AwsWorkSpaceDirectory AzureAppServicePlan AzureAutomationAccount AzureCosmosDb AzureDataLakeAnalytics AzureDataLakeStore AzureExpressRouteCircuit AzureVirtualNetworkGateway AzureAppServicePlanSubgroup Service AwsDmsReplication AzureMariaDb AzureApplicationInsights AzureFirewall AzureSQLElasticPool AzureSQLManagedInstance AzureHDInsight AzureRecoveryServices AzureNetworkInterface AzureBatchAccount AzureLogicApps AzureDataFactory AzurePublicIP AzureStreamAnalytics AzureEventGrid AzureLoadBalancers AzureServiceFabricMesh AzureCognitiveSearch AzureCognitiveServices AzureMLWorkspaces AzureFrontDoors AzureKeyVault AzureRelayNamespaces AzureNotificationHubs AzureAppServiceEnvironment Unknown2001 Unknown2003 DeviceGroupsOnly ServiceGroupsOnly	All
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
errorOnOverflow	Boolean			Optional	Should NCalc expression evaluation throw error on Overflow	true false	true
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
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
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
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
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
filterProperty	String			Optional	Specify the property that you want to filter on, e.g. Name or any custom property. If 'filterProperty' is set, 'filterPropertyValue' is mandatory.	N/A	N/A
filterPropertyValue	TildaOptionString			Optional	Specify the value that you want to filter on. 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
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
fontBold	Boolean			Optional	Change the font weight (true=strong, false=normal). If omitted, no change is made.	true false	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
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
group	List<String>	Deprecated	resourceGroups		The Device Group (or semicolon-separated list of Device Groups). Use "/" or no value in the deviceGroup parameter to reference the root folder.	N/A	/
groups	List<String>	Deprecated	resourceGroups		The Device Group (or semicolon-separated list of Device Groups). Use "/" or no value in the deviceGroup parameter to reference the root folder.	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
includeRootLevel	Boolean			Optional	When used with property=RelativePath, includes the root level in the output list. When true the root is represented as a '/'	true false	false
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
isAlertingEnabled	Boolean			Optional	When specified only brings back Device Groups where the alerting is/is not switched on for that Device Group. Inheritance from parent DeviceGroups is not supported by this parameter.	true false	N/A
listDelimiter	Char	Use instead of: delimiter		Optional	In Legacy Mode, the delimiter character to use between multiple items in the output.	N/A	;
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 object, e.g. an Int32 or a List etc., rather than a formatted string.	Legacy Normal	Legacy
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
normalFontBold	Boolean			Optional	Change the normal font weight (true=strong, false=normal). If omitted, no change is made.	true false	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
normalFontSize	Double			Optional	Change the normal font size in points. If omitted, no change is made.	From 2 to 200	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
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
orderBy	DeviceGroupProperty			Optional	Specifies the property to order by from the supported properties. Note that using 'AllAsJObject' and 'AllAsJson' have no effect.	FullPath AllAsJson Description AppliesTo Id Name RelativePath AllAsJObject	FullPath
orderByDescending	String			Optional	Specifies the property to order descending by from the supported properties. Do not use in conjunction with the 'orderBy' parameter (if you do, 'orderBy' will be ignored).	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
property	DeviceGroupProperty			Optional	Return the properties for the specified Device Group. Note that when 'type=Service' is used, this parameter has no effect and a list of jObjects is always produced, i.e. the equivalent of property=AllAsJObject.	FullPath AllAsJson Description AppliesTo Id Name RelativePath AllAsJObject	FullPath
recurse	Boolean	Deprecated	recurseResourceGroups		Whether to recurse device groups. Specify true to include child Device Groups.	true false	false
recurseDeviceGroups	Boolean	Deprecated	recurseResourceGroups		Whether to recurse device groups. Specify true to include child Device Groups.	true false	false
recurseResourceGroups	Boolean	Use instead of: recurse recurseDeviceGroups		Optional	Whether to recurse device groups. Specify true to include child Device Groups.	true false	false
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
resourceGroups	List<String>	Use instead of: deviceGroup deviceGroups group groups		Optional	The Device Group (or semicolon-separated list of Device Groups). Use "/" or no value in the deviceGroup parameter to reference the root folder.	N/A	/
selectDistinct	Boolean			Optional	Specify false to include repeated entries.	true false	true
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
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
type	DeviceGroupListType			Optional	Whether to list Device Groups or Services. Can only be set to 'type=Service' in Normal Mode, and the only properties supported are 'AllAsJObject'. Failure to adhere to this will cause a Macro Error.	DeviceGroup Service	DeviceGroup
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
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

Examples (10)

Example 1:

[LogicMonitor.DeviceGroupList: deviceGroups=PDL - Panoramic Data/Datacenter, property=Name, storeAs=Group]

Example 2:

[LogicMonitor.DeviceGroupList: deviceGroups=PDL - Panoramic Data/Datacenter, property=Name, recurseDeviceGroups=true, storeAs=Group and Subgroups]

Example 3:

Use a different delimiter between list items.

[LogicMonitor.DeviceGroupList: deviceGroups=PDL - Panoramic Data/Datacenter, property=Name, recurseDeviceGroups=true, delimiter=*]

Example 4:

Ensure there is a macro error when the Device Group does not exist.

[LogicMonitor.DeviceGroupList: deviceGroups=I DO NOT EXIST, property=Name, checkDeviceGroupsExist=true]

Example 5:

List only device groups whose Name property contains the text "Pu".

[LogicMonitor.DeviceGroupList: deviceGroups=PDL - Panoramic Data/Datacenter, property=Name, recurseDeviceGroups=true, filterProperty=Name, filterPropertyValue~=Pu]

Example 6:

List only device groups whose Name property is 'Public'.

[LogicMonitor.DeviceGroupList: deviceGroups=PDL - Panoramic Data/Datacenter, property=Name, recurseDeviceGroups=true, filterProperty=Name, filterPropertyValue=Public]

Example 7:

[LogicMonitor.DeviceGroupList: deviceGroups=PDL - Panoramic Data/Datacenter;QA, property=Name, recurseDeviceGroups=true, storeAs=Groups and Subgroups]

Example 8:

[LogicMonitor.DeviceGroupList: deviceGroups=PDL - Panoramic Data/Datacenter;QA, property=Name, recurseDeviceGroups=true, storeAs=Groups and Subgroups, orderByDescending=Name]

Example 9:

[LogicMonitor.DeviceGroupList: deviceGroups=PDL - Panoramic Data/Datacenter, property=RelativePath, recurseDeviceGroups=true, storeAs=Groups and Subgroups, orderByDescending=RelativePath, includeRootLevel=true]

Example 10:

Include only Service Groups in the root:

[LogicMonitor.DeviceGroupList: deviceGroups=, property=Name, storeAs=ServiceGroupsAtRoot, deviceGroupType=ServiceGroupsOnly]