[LogicMonitor.DeviceCount:]UPDATED

Outputs the count of Devices in the specified Device Groups.


Compatibility

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


Updates

v4.5One month ago · September 2026

Now fetches only the two device fields it needs to produce a count, rather than every property of every device. Substantially less data is transferred from LogicMonitor, and the count returned is unchanged.

History (1)
v4.5One month ago · September 2026

Added the 'properties' parameter, which returns a JArray of JObjects carrying exactly the properties named, supports 'x as y' renaming and dotted paths, and fetches only the properties needed - making large resource lists substantially faster.


Parameters (122)
Behaviour (1)13 additional
Parameter TypePresencePurpose Options Default
recurseDeviceGroups
BooleanOptionalInclude devices in all child folders.
  • true
  • false
true
Additional (13)
Parameter TypePresencePurpose Options Default
calculate
StringOptionalPost processing formula. Use {value} to substitute the macro's output into the formula as text, e.g. {value}/1024, or the bare word value to use the output itself, e.g. jPath(value, 'id') to read a property from an object. If the result is fractional it is shown to two decimal places unless you also set format, e.g. format=G to show it in full; a value kept by storeAs always retains its full precision. N/A N/A
desiredExecutionResult
List<ExecutionResult>OptionalIf specified, asserts the expected execution result of the macro. Accepts a single value or a semicolon-separated list of acceptable values (e.g. 'Success;Warning'). The macro executes normally; if the actual result matches any of the desired values, 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' and 'Stopped'.
  • Cancelled
  • Deferred
  • MacroError
  • NeverRun
  • Paused
  • Pending
  • Running
  • Stopped
  • Success
  • SystemError
  • Warning
  • WorkerStopped
N/A
errorOnOverflow
BooleanOptionalShould NCalc expression evaluation throw error on Overflow
  • true
  • false
true
expectedType
StringOptionalIf 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
StringOptionalIf 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
hidden
BooleanOptionalWhether to hide the macro output.
  • true
  • false
false
if
StringOptionalThe 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
Int32OptionalThe maximum number of attempts when requesting data via the LogicMonitor API.
  • From 1 to 2147483647
N/A
mode
MacroModeOptionalThe mode in which variables are stored. In legacy mode (default for Schedules), the variable created is a string and formatted. In normal mode (default for Report Studio), the output variable is stored as a strongly-typed object, e.g. an Int32 or a JArray etc., rather than a formatted string.
  • Legacy
  • Normal
Legacy
obfuscation
ObfuscationTypeOptionalObfuscation 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
BooleanOptionalWhether 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
BooleanOptionalWhether to wait during LogicMonitor upgrades (i.e. execution essentially pauses).
  • true
  • false
N/A
warning
StringOptionalIf 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 (21)
Parameter TypePresencePurpose Options Default
colorTableCell
BooleanOptionalWhether to color table cells if thresholds are breached, rather than color the text.
  • true
  • false
true
criticalFontBackgroundColor
ColorOptionalThe critical font background color to use. If omitted, no change is made. N/A
criticalFontColor
ColorOptionalThe critical font color to use. If omitted, no change is made. N/A
criticalTableCellBackgroundColor
ColorOptionalThe critical table cell background color to use. If omitted, no change is made. N/A
errorFontBackgroundColor
ColorOptionalThe error font background color to use. If omitted, no change is made. N/A
errorFontColor
ColorOptionalThe error font color to use. If omitted, no change is made. N/A
errorTableCellBackgroundColor
ColorOptionalThe error table cell background color to use. If omitted, no change is made. N/A
fatalFontBackgroundColor
ColorOptionalThe fatal font background color to use. If omitted, no change is made. N/A
fatalFontColor
ColorOptionalThe fatal font color to use. If omitted, no change is made. N/A
fatalTableCellBackgroundColor
ColorOptionalThe fatal table cell background color to use. If omitted, no change is made. N/A
fontBackgroundColor
ColorOptionalThe font background color to use. N/A
fontColor
ColorOptionalThe font color to use. N/A
infoFontBackgroundColor
ColorOptionalThe info font background color to use. If omitted, no change is made. N/A
infoFontColor
ColorOptionalThe info font color to use. If omitted, no change is made. N/A
infoTableCellBackgroundColor
ColorOptionalThe info table cell background color to use. If omitted, no change is made. N/A
normalFontBackgroundColor
ColorOptionalThe normal font background color to use. If omitted, no change is made. N/A
normalFontColor
ColorOptionalThe normal font color to use. If omitted, no change is made. N/A
normalTableCellBackgroundColor
ColorOptionalThe normal table cell background color to use. If omitted, no change is made. N/A
warningFontBackgroundColor
ColorOptionalThe warning font background color to use. If omitted, no change is made. N/A
warningFontColor
ColorOptionalThe warning font color to use. If omitted, no change is made. N/A
warningTableCellBackgroundColor
ColorOptionalThe warning table cell background color to use. If omitted, no change is made. N/A
Formatting (15)
Parameter TypePresencePurpose Options Default
criticalFontBold
BooleanOptionalChange the critical font weight (true=strong, false=normal). If omitted, no change is made.
  • true
  • false
N/A
criticalFontSize
DoubleOptionalChange the critical font size in points. If omitted, no change is made.
  • From 2 to 200
N/A
errorFontBold
BooleanOptionalChange the error font weight (true=strong, false=normal). If omitted, no change is made.
  • true
  • false
N/A
errorFontSize
DoubleOptionalChange the error font size in points. If omitted, no change is made.
  • From 2 to 200
N/A
fatalFontBold
BooleanOptionalChange the fatal font weight (true=strong, false=normal). If omitted, no change is made.
  • true
  • false
N/A
fatalFontSize
DoubleOptionalChange the fatal font size in points. If omitted, no change is made.
  • From 2 to 200
N/A
fontBold
BooleanOptionalChange the font weight (true=strong, false=normal). If omitted, no change is made.
  • true
  • false
N/A
fontSize
DoubleOptionalChange the font size in points. If omitted, no change is made.
  • From 2 to 200
N/A
format
StringOptionalThe formatting to use for numbers. You can also specify 'format=string' to force numbers to be treated as strings. For dates, C# date formats are supported, plus two special values (in any casing): 'format=dayOfWeek' for the day of the week as a number (Sunday = 0; use 'format=dddd' for the day name) and 'format=epoch' for the number of seconds since 1970-01-01 UTC. N/A N/A
infoFontBold
BooleanOptionalChange the info font weight (true=strong, false=normal). If omitted, no change is made.
  • true
  • false
N/A
infoFontSize
DoubleOptionalChange the info font size in points. If omitted, no change is made.
  • From 2 to 200
N/A
normalFontBold
BooleanOptionalChange the normal font weight (true=strong, false=normal). If omitted, no change is made.
  • true
  • false
N/A
normalFontSize
DoubleOptionalChange the normal font size in points. If omitted, no change is made.
  • From 2 to 200
N/A
warningFontBold
BooleanOptionalChange the warning font weight (true=strong, false=normal). If omitted, no change is made.
  • true
  • false
N/A
warningFontSize
DoubleOptionalChange the warning font size in points. If omitted, no change is made.
  • From 2 to 200
N/A
Conditional Formatting (35)
Parameter TypePresencePurpose Options Default
criticalEq
StringOptionalThe macro is considered 'critical' if the output is equal to this value. N/A N/A
criticalGe
StringOptionalThe macro is considered 'critical' if the output is greater than or equal to this value. N/A N/A
criticalGt
StringOptionalThe macro is considered 'critical' if the output is greater than this value. N/A N/A
criticalIf
StringOptionalThe macro is considered 'critical' if the expression evaluates to true. Use 'value' as the macro output in the expression. N/A N/A
criticalLe
StringOptionalThe macro is considered 'critical' if the output is less than or equal to this value. N/A N/A
criticalLt
StringOptionalThe macro is considered 'critical' if the output is less than this value. N/A N/A
criticalNe
StringOptionalThe macro is considered 'critical' if the output is not equal to this value. N/A N/A
errorEq
StringOptionalThe macro is considered 'error' if the output is equal to this value. N/A N/A
errorGe
StringOptionalThe macro is considered 'error' if the output is greater than or equal to this value. N/A N/A
errorGt
StringOptionalThe macro is considered 'error' if the output is greater than this value. N/A N/A
errorIf
StringOptionalThe macro is considered 'error' if the expression evaluates to true. Use 'value' as the macro output in the expression. N/A N/A
errorLe
StringOptionalThe macro is considered 'error' if the output is less than or equal to this value. N/A N/A
errorLt
StringOptionalThe macro is considered 'error' if the output is less than this value. N/A N/A
errorNe
StringOptionalThe macro is considered 'error' if the output is not equal to this value. N/A N/A
fatalEq
StringOptionalThe macro is considered 'fatal' if the output is equal to this value. N/A N/A
fatalGe
StringOptionalThe macro is considered 'fatal' if the output is greater than or equal to this value. N/A N/A
fatalGt
StringOptionalThe macro is considered 'fatal' if the output is greater than this value. N/A N/A
fatalIf
StringOptionalThe macro is considered 'fatal' if the expression evaluates to true. Use 'value' as the macro output in the expression. N/A N/A
fatalLe
StringOptionalThe macro is considered 'fatal' if the output is less than or equal to this value. N/A N/A
fatalLt
StringOptionalThe macro is considered 'fatal' if the output is less than this value. N/A N/A
fatalNe
StringOptionalThe macro is considered 'fatal' if the output is not equal to this value. N/A N/A
infoEq
StringOptionalThe macro is considered 'info' if the output is equal to this value. N/A N/A
infoGe
StringOptionalThe macro is considered 'info' if the output is greater than or equal to this value. N/A N/A
infoGt
StringOptionalThe macro is considered 'info' if the output is greater than this value. N/A N/A
infoIf
StringOptionalThe macro is considered 'info' if the expression evaluates to true. Use 'value' as the macro output in the expression. N/A N/A
infoLe
StringOptionalThe macro is considered 'info' if the output is less than or equal to this value. N/A N/A
infoLt
StringOptionalThe macro is considered 'info' if the output is less than this value. N/A N/A
infoNe
StringOptionalThe macro is considered 'info' if the output is not equal to this value. N/A N/A
warningEq
StringOptionalThe macro is considered 'warning' if the output is equal to this value. N/A N/A
warningGe
StringOptionalThe macro is considered 'warning' if the output is greater than or equal to this value. N/A N/A
warningGt
StringOptionalThe macro is considered 'warning' if the output is greater than this value. N/A N/A
warningIf
StringOptionalThe macro is considered 'warning' if the expression evaluates to true. Use 'value' as the macro output in the expression. N/A N/A
warningLe
StringOptionalThe macro is considered 'warning' if the output is less than or equal to this value. N/A N/A
warningLt
StringOptionalThe macro is considered 'warning' if the output is less than this value. N/A N/A
warningNe
StringOptionalThe macro is considered 'warning' if the output is not equal to this value. N/A N/A
Filtering & Sorting (6)
Parameter TypePresencePurpose Options Default
filter
StringOptionalFor advanced filtering, use the LogicMonitor API's filtering system. This feature is only supported through professional services. N/A N/A
filterProperty
StringOptionalSpecify the property that you want to filter on, e.g. system.sysinfo. If filterProperty is set, filterPropertyValue is mandatory. N/A N/A
filterPropertyValue
TildaOptionStringOptionalspecify 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
StringOptionalOnly 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
DevicePropertyOptionalOrder 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
BooleanOptionalEliminate duplicates if set to true.
  • true
  • false
false
Output (1)7 additional
Parameter TypePresencePurpose Options Default
delimiter
CharOptionalThe delimiter to use between multiple items in the output. N/A ;
Additional (7)
Parameter TypePresencePurpose Options Default
failureText
StringOptionalThe 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
StringOptionalThe 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
BooleanOptionalAny macros that output lists can optionally (in Normal mode) output a jArray instead.
  • true
  • false
true
storeAs
StringOptionalThe variable to store the result as. If the variable name ends 'Json' (any casing) its value is wrapped in json tags. That marks the value as JSON so it can be passed straight into a parameter that expects json content, and the RMScript editor also displays it with JSON highlighting. When several variables are stored at once each one is judged by its own name. N/A N/A
storeAsHidden
StringOptionalThe variable to store the result as, while hiding the output. Equivalent to 'storeAs=ThisValue, hidden=true'. N/A N/A
storeAsVariableDelimiter
CharOptionalThe delimiter used by storeAs to split a TEXT value, 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=*]. If splitting on this delimiter does not produce one value per variable, the '^' character is tried instead; that applies whatever this parameter is set to, and is what allows a single variable to hold a value containing a ';'. Note this delimiter is only used for a TEXT value. A list or a JSON array is instead shared out one element per variable, and a JSON object by its property values in order, so storing jObject('a',1,'b',2) as two variables gives 1 and 2. Any other type cannot be split across several variables at all. N/A ;
storeFormattedValueAs
StringOptionalThe 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. As with 'storeAs', a name ending 'Json' has its value wrapped in json tags. N/A N/A
General (16)3 additional
Parameter TypePresencePurpose Options Default
createdBefore
DateTimeOffsetOptionalOnly include devices that were created before this time (UTC). N/A N/A
dataSourceExists
StringOptionalThe 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
StringOptionalThe 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
StringOptionalThe 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
StringOptionalThe 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>OptionalThe Device Group or Device Groups (semi-colon separated). Use "/" or no value to reference the root folder. N/A /
instanceCountEq
Int32OptionalOnly 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
Int32OptionalOnly 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
Int32OptionalOnly 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
Int32OptionalOnly 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
Int32OptionalOnly 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
Int32OptionalOnly 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
BooleanOptionalWhen specified only brings back DeviceGroups where the alerting is/is not enabled
  • true
  • false
N/A
properties
List<String>OptionalReturn these properties, as a JArray of JObjects carrying exactly the properties named. Separate multiple properties with a semicolon. Use 'x as y' to give the output key a different name from the property, 'x.y' to reach a nested property, and 'all' on its own to return the complete object. The output is always a JArray of JObjects, in both normal and legacy mode. This is a separate parameter from 'property', not another name for it, and the two cannot be used together.
  • AlertDisableStatus
  • AlertingDisabledOn
  • AlertStatus
  • AlertStatusPriority
  • All
  • AncestorHasDisabledLogicModule
  • AutoBalancedCollectorGroupId
  • AutoProperties
  • AutoPropertiesAssignedOnSeconds
  • AutoPropertiesAssignedOnUtc
  • AutoPropertiesUpdatedOnSeconds
  • AutoPropertiesUpdatedOnUtc
  • AutoVisualResult
  • AwsState
  • AwsTestResult
  • AwsTestResultCode
  • AzureState
  • AzureTestResult
  • AzureTestResultCode
  • CanUseRemoteSession
  • Checkpoints
  • ClonedFromHostId
  • CollectorDescription
  • Collectors
  • ContainsMultiValue
  • Count
  • CreatedOnSeconds
  • CreatedOnUtc
  • CurrentCollectorId
  • CurrentLogCollectorId
  • CustomProperties
  • DedicatedLogCollectorGroupId
  • DeletedTimeInMs
  • Description
  • DisplayName
  • Domain
  • EffectiveAlertEnabled
  • EnableNetflow
  • GcpState
  • GcpTestResult
  • GcpTestResultCode
  • GlobalSmAlertCond
  • GroupIds
  • HasActiveInstance
  • HasDisabledSubResource
  • HasMore
  • Host
  • Id
  • IndividualAlertLevel
  • IndividualSmAlertEnable
  • InheritedProperties
  • Instances
  • IsAlertingDisabled
  • IsInternal
  • IsPreferredLogCollectorConfigured
  • IsPreferredLogCollectorGroupConfigured
  • LastDataTimeSeconds
  • LastDataUtc
  • LastRawDataTimeSeconds
  • LastRawDataUtc
  • LastUpdated
  • Link
  • LoadBalanceCollectorGroupId
  • LogCollectorDescription
  • LogCollectorGroupId
  • LogCollectorGroupName
  • LogCollectorId
  • ManualDiscoveryFlags
  • Name
  • NetflowCollectorDescription
  • NetflowCollectorGroupId
  • NetflowCollectorGroupName
  • NetflowCollectorId
  • Op
  • OverallAlertLevel
  • PercentPktsNotReceiveInTime
  • PollingInterval
  • PreferredCollectorGroupId
  • PreferredCollectorGroupName
  • PreferredCollectorId
  • Properties
  • RelatedResourceId
  • ResourceGroupIdsString
  • ResourceIds
  • ResourceStatus
  • ResourceType
  • RolePrivileges
  • SaasTestResult
  • SaasTestResultCode
  • ScanConfigId
  • SdtStatus
  • Status
  • Steps
  • StopMonitoring
  • StopMonitoringByFolder
  • SyntheticsCollectorIds
  • SystemProperties
  • Template
  • TestLocation
  • TimeoutInMSPktsNotReceive
  • ToDeleteTimeInMs
  • Transition
  • Type
  • UpdatedOnSeconds
  • UpdatedOnUtc
  • UptimeInSeconds
  • UseDefaultAlertSetting
  • UseDefaultLocationSetting
  • UserPermission
N/A
status
StringOptionalOnly include devices in this status. Supported values: Dead and Normal. N/A N/A
type
DeviceListTypeOptionalWhether to include Devices, Services, or both.
  • Device
  • Service
  • All
Device
Additional (3)
Parameter TypePresencePurpose Options Default
comment
StringOptionalAdd a comment to make your document template more readable. The comment is discarded in the output document. N/A N/A
connectionName
StringOptionalThe name of the LogicMonitor Connection. N/A N/A
singleValueList
Normal mode
BooleanOptionalIn 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 TypePreferred ParameterPurpose Options Default
deviceGroups
List<String>deviceGroupThe Device Group or Device Groups (semi-colon separated). Use "/" or no value to reference the root folder. N/A /
group
List<String>deviceGroupThe Device Group or Device Groups (semi-colon separated). Use "/" or no value to reference the root folder. N/A /
groups
List<String>deviceGroupThe Device Group or Device Groups (semi-colon separated). Use "/" or no value to reference the root folder. N/A /
recurseDeviceGroup
BooleanrecurseDeviceGroupsInclude devices in all child folders.
  • true
  • false
true

Examples (2)

Example 1

This example outputs the total number of Devices:

There are [LogicMonitor.DeviceCount: deviceGroup=/, recurseDeviceGroups=true] Devices.

Example 2Normal mode

This Normal Mode example outputs the number of the Devices in the first Device Group:

[LogicMonitor.DeviceGroupList: deviceGroups=/, recurseDeviceGroups=true, property=FullPath, orderBy=Description, mode=Normal, =>DeviceGroups][Json.List: jArray={=DeviceGroups}, jsonPath="$.[0].FullPath", =>FirstDeviceGroup][LogicMonitor.DeviceCount: deviceGroup={FirstDeviceGroup}, recurseDeviceGroups=false, mode=Normal, storeAs=Count]

Reconnection

Reconnection

Reconnection

timed out

timed out

Attempt of

Reload
An unhandled error has occurred. Reload 🗙