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.
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).
Behaviour (3)9 additional
| Parameter | Type | Presence | Purpose | Options | Default |
| Int32 | Optional | The maximum number of attempts when requesting data via the LogicMonitor API. |
|
N/A | |
| Boolean | Optional | Whether to recurse device groups. Specify true to include child Device Groups. |
|
false | |
| Boolean | Optional | Whether to wait during LogicMonitor upgrades (i.e. execution essentially pauses). |
|
N/A |
Additional (9)
| Parameter | Type | Presence | Purpose | Options | Default |
| String | Optional | Post processing formula. Use {value} for the macro output, e.g. {value}/1024. | N/A | N/A | |
| Boolean | Optional | Should NCalc expression evaluation throw error on Overflow |
|
true | |
| 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 | |
| Boolean | Optional | Whether to hide the macro output. |
|
false | |
| 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 | |
| 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 |
|
Legacy | |
| 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 | |
| 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). |
|
false | |
| 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 |
| Boolean | Optional | Whether to color table cells if thresholds are breached, rather than color the text. |
|
true | |
| Color | Optional | The font background color to use. |
|
N/A | |
| Color | Optional | The font color to use. |
|
N/A | |
| Color | Optional | The normal font background color to use. If omitted, no change is made. |
|
N/A | |
| Color | Optional | The normal font color to use. If omitted, no change is made. |
|
N/A | |
| Color | Optional | The normal table cell background color to use. If omitted, no change is made. |
|
N/A |
Formatting (5)
| Parameter | Type | Presence | Purpose | Options | Default |
| Boolean | Optional | Change the font weight (true=strong, false=normal). If omitted, no change is made. |
|
N/A | |
| Double | Optional | Change the font size in points. If omitted, no change is made. |
|
N/A | |
| 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 | |
| Boolean | Optional | Change the normal font weight (true=strong, false=normal). If omitted, no change is made. |
|
N/A | |
| Double | Optional | Change the normal font size in points. If omitted, no change is made. |
|
N/A |
Conditional Formatting (69)
| Parameter | Type | Presence | Purpose | Options | Default |
| DateTimeOffset | Optional | The macro is considered 'critical' if the output is after this DateTime UTC. | N/A | N/A | |
| DateTimeOffset | Optional | The macro is considered 'critical' if the output is before this DateTime UTC. | N/A | N/A | |
| String | Optional | The macro is considered 'critical' if the output is equal to this value. | N/A | N/A | |
| Color | Optional | The critical font background color to use. If omitted, no change is made. |
|
N/A | |
| Boolean | Optional | Change the font weight (true=strong, false=normal). If omitted, no change is made. |
|
N/A | |
| Color | Optional | The critical font color to use. If omitted, no change is made. |
|
N/A | |
| Double | Optional | Change the critical font size in points. If omitted, no change is made. |
|
N/A | |
| String | Optional | The macro is considered 'critical' if the output is greater than or equal to this value. | N/A | N/A | |
| String | Optional | The macro is considered 'critical' if the output is greater than this value. | N/A | N/A | |
| 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 | |
| String | Optional | The macro is considered 'critical' if the output is less than or equal to this value. | N/A | N/A | |
| String | Optional | The macro is considered 'critical' if the output is less than this value. | N/A | N/A | |
| String | Optional | The macro is considered 'critical' if the output is not equal to this value. | N/A | N/A | |
| Color | Optional | The critical table cell background color to use. |
|
N/A | |
| DateTimeOffset | Optional | The macro is considered 'error' if the output is after this DateTime UTC. | N/A | N/A | |
| DateTimeOffset | Optional | The macro is considered 'error' if the output is before this DateTime UTC. | N/A | N/A | |
| String | Optional | The macro is considered 'error' if the output is equal to this value. | N/A | N/A | |
| Color | Optional | The error font background color to use. If omitted, no change is made. |
|
N/A | |
| Boolean | Optional | Change the error font weight (true=strong, false=normal). If omitted, no change is made. |
|
N/A | |
| Color | Optional | The error font color to use. If omitted, no change is made. |
|
N/A | |
| Double | Optional | Change the error font size in points. If omitted, no change is made. |
|
N/A | |
| String | Optional | The macro is considered 'error' if the output is greater than or equal to this value. | N/A | N/A | |
| String | Optional | The macro is considered 'error' if the output is greater than this value. | N/A | N/A | |
| 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 | |
| String | Optional | The macro is considered 'error' if the output is less than or equal to this value. | N/A | N/A | |
| String | Optional | The macro is considered 'error' if the output is less than this value. | N/A | N/A | |
| String | Optional | The macro is considered 'error' if the output is not equal to this value. | N/A | N/A | |
| Color | Optional | The error table cell background color to use. |
|
N/A | |
| DateTimeOffset | Optional | The macro is considered 'fatal' if the output is after this DateTime UTC. | N/A | N/A | |
| DateTimeOffset | Optional | The macro is considered 'fatal' if the output is before this DateTime UTC. | N/A | N/A | |
| String | Optional | The macro is considered 'fatal' if the output is equal to this value. | N/A | N/A | |
| Color | Optional | The fatal font background color to use. If omitted, no change is made. |
|
N/A | |
| Boolean | Optional | Change the fatal font weight (true=strong, false=normal). If omitted, no change is made. |
|
N/A | |
| Color | Optional | The fatal font color to use. If omitted, no change is made. |
|
N/A | |
| Double | Optional | Change the fatal font size in points. If omitted, no change is made. |
|
N/A | |
| String | Optional | The macro is considered 'fatal' if the output is greater than or equal to this value. | N/A | N/A | |
| String | Optional | The macro is considered 'fatal' if the output is greater than this value. | N/A | N/A | |
| String | Optional | The macro is considered 'fatal' if the output is less than or equal to this value. | N/A | N/A | |
| String | Optional | The macro is considered 'fatal' if the output is less than this value. | N/A | N/A | |
| String | Optional | The macro is considered 'fatal' if the output is not equal to this value. | N/A | N/A | |
| Color | Optional | The fatal table cell background color to use. |
|
N/A | |
| DateTimeOffset | Optional | The macro is considered 'info' if the output is after this DateTime UTC. | N/A | N/A | |
| DateTimeOffset | Optional | The macro is considered 'info' if the output is before this DateTime UTC. | N/A | N/A | |
| String | Optional | The macro is considered 'info' if the output is equal to this value. | N/A | N/A | |
| Color | Optional | The info font background color to use. If omitted, no change is made. |
|
N/A | |
| Boolean | Optional | Change the info font weight (true=strong, false=normal). If omitted, no change is made. |
|
N/A | |
| Color | Optional | The info font color to use. If omitted, no change is made. |
|
N/A | |
| Double | Optional | Change the info font size in points. If omitted, no change is made. |
|
N/A | |
| String | Optional | The macro is considered 'info' if the output is greater than or equal to this value. | N/A | N/A | |
| String | Optional | The macro is considered 'info' if the output is greater than this value. | N/A | N/A | |
| 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 | |
| String | Optional | The macro is considered 'info' if the output is less than or equal to this value. | N/A | N/A | |
| String | Optional | The macro is considered 'info' if the output is less than this value. | N/A | N/A | |
| String | Optional | The macro is considered 'info' if the output is not equal to this value. | N/A | N/A | |
| Color | Optional | The info table cell background color to use. |
|
N/A | |
| DateTimeOffset | Optional | The macro is considered 'warning' if the output is after this DateTime UTC. | N/A | N/A | |
| DateTimeOffset | Optional | The macro is considered 'warning' if the output is before this DateTime UTC. | N/A | N/A | |
| String | Optional | The macro is considered 'warning' if the output is equal to this value. | N/A | N/A | |
| Color | Optional | The warning font background color to use. If omitted, no change is made. |
|
N/A | |
| Boolean | Optional | Change the warning font weight (true=strong, false=normal). If omitted, no change is made. |
|
N/A | |
| Color | Optional | The warning font color to use. If omitted, no change is made. |
|
N/A | |
| Double | Optional | Change the warning font size in points. If omitted, no change is made. |
|
N/A | |
| String | Optional | The macro is considered 'warning' if the output is greater than or equal to this value. | N/A | N/A | |
| String | Optional | The macro is considered 'warning' if the output is greater than this value. | N/A | N/A | |
| 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 | |
| String | Optional | The macro is considered 'warning' if the output is less than or equal to this value. | N/A | N/A | |
| String | Optional | The macro is considered 'warning' if the output is less than this value. | N/A | N/A | |
| String | Optional | The macro is considered 'warning' if the output is not equal to this value. | N/A | N/A | |
| Color | Optional | The warning table cell background color to use. |
|
N/A |
Filtering & Sorting (6)
| Parameter | Type | Presence | Purpose | Options | Default |
| 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 | |
| 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 | |
| Boolean | Optional | When used with property=RelativePath, includes the root level in the output list. When true the root is represented as a '/' |
|
false | |
| DeviceGroupProperty | Optional | Specifies the property to order by from the supported properties. Note that using 'AllAsJObject' and 'AllAsJson' have no effect. |
|
FullPath | |
| 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 | |
| Boolean | Optional | Specify false to include repeated entries. |
|
true |
Output (1)7 additional
| Parameter | Type | Presence | Purpose | Options | Default |
| Char | Optional | In Legacy Mode, the delimiter character to use between multiple items in the output. | N/A | ; |
Additional (7)
| Parameter | Type | Presence | Purpose | Options | Default |
| 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 | |
| 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 | |
Normal mode |
Boolean | Optional | Any macros that output lists can optionally (in Normal mode) output a jArray instead. |
|
true |
| String | Optional | The variable to store the result as. | N/A | N/A | |
| String | Optional | The variable to store the result as, while hiding the output. Equivalent to 'storeAs=ThisValue, hidden=true'. | N/A | N/A | |
| 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=a*b*c*d, storeAs=var1;var2;var3;var4, storeAsVariableDelimiter=*] | N/A | ; | |
| 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 (7)5 additional
| Parameter | Type | Presence | Purpose | Options | Default |
| 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. |
|
false | |
| String | Optional | The name of the LogicMonitor Connection. | N/A | N/A | |
| DeviceGroupType | Optional | Filter the results by the type of Device Group. |
|
All | |
| 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. |
|
N/A | |
| 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 | |
| List<String> | 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 | / | |
| 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 |
Additional (5)
| Parameter | Type | Presence | Purpose | Options | Default |
| String | Optional | Add a comment to make your document template more readable. The comment is discarded in the output document. | N/A | N/A | |
| 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. |
|
N/A | |
| 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 | |
| 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 | |
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. |
|
false |
Deprecated (7)
| Parameter | Type | Preferred Parameter | Purpose | Options | Default |
| Char | listDelimiter | In Legacy Mode, the delimiter character to use between multiple items in the output. | N/A | ; | |
| List<String> | 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 | / | |
| List<String> | 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 | / | |
| List<String> | 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 | / | |
| List<String> | 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 | / | |
| Boolean | recurseResourceGroups | Whether to recurse device groups. Specify true to include child Device Groups. |
|
false | |
| Boolean | recurseResourceGroups | Whether to recurse device groups. Specify true to include child Device Groups. |
|
false |
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=GroupAndSubgroups]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=GroupsAndSubgroups]Example 8
[LogicMonitor.DeviceGroupList: deviceGroups=PDL - Panoramic Data/Datacenter;QA, property=Name, recurseDeviceGroups=true, storeAs=GroupsAndSubgroups, orderByDescending=Name]Example 9
[LogicMonitor.DeviceGroupList: deviceGroups=PDL - Panoramic Data/Datacenter, property=FullPath, recurseDeviceGroups=true, storeAs=GroupsAndSubgroups, orderByDescending=FullPath, includeRootLevel=true]Example 10
Include only Service Groups in the root:
[LogicMonitor.DeviceGroupList: deviceGroups=, property=Name, storeAs=ServiceGroupsAtRoot, deviceGroupType=ServiceGroupsOnly]