Quick StartThe ReportMagic MenuSchedulesBatch JobsReport StudioFilesProfileAdminAccount DetailsMeraki WebHooksGetting StartedAbout ReportMagicRegistering and Logging InSearching ReportMagicConnections and AgentsWriting ReportsStarting Out With Report StudioCreating Report TemplatesRMScriptMacro ShorthandReporting on Different Periods of TimeSetting Macro Parameter DefaultsStoring Input and Output FilesReport VariablesUsing Variable ParametersSpecifying How Graphs LookStep-by-Step LogicMonitor Graph ExamplesStep-by-Step Jira Graph ExamplesSpecifying How Tables LookChanging Fonts and ColorsUsing Macros in PowerPoint TemplatesRestricted MacrosGenerating Reports Using SchedulesUsing HTML Forms in SchedulesSeeing How Reports RanViewing ReportsCached ValuesUsing AggregationsAdvanced Report StudioAPI AccessREST APIREST API - FilesAdvancedRole-Based Access Control (RBAC)SecurityMiscellaneousBadgesCertificationsTips, Tricks and Shortcut KeysMacrosAgentAgent.ConnectionAgent.ExecuteAgent.MonitorMagicNodeListAgent.MonitorMagicNodeMeasurementListAgent.MonitorMagicNodeMeasurementSummaryAgent.MonitorMagicNodePropertyListAgent.MonitorMagicNodeTypeListAgent.PropertyAgent.SqlAnalysisAgent.SqlGraphAgent.SqlListAgent.SqlTableAgent.SqlValueAgent.SqlValuesAgent.WebQueryAlertMagicAlertMagic.MetricsGraphAlertMagic.MetricsListAutoTaskAutoTask.AccountListAutoTask.AccountPropertyAutoTask.ConnectionAutoTask.CountAutoTask.FieldListAutoTask.FieldPropertyAutoTask.ListAutoTask.PropertyAutoTask.SummaryValueAutoTask.TicketListAutoTask.TicketPropertyAzureAzure.ConnectionAzure.LogAnalyticsGraphAzure.LogAnalyticsQueryAzure.LogAnalyticsScalarAzure.LogAnalyticsTableAzure.ResourceGroupListAzure.ResourceListAzure.ResourcePropertiesAzure.SentinelAlertRuleListAzure.SentinelConnectorListAzure.SentinelIncidentListAzure.SentinelThreatIndicatorListAzure.SentinelThreatIndicatorMetricListAzure.SubscriptionListBloggerBlogger.BlogPropertyBlogger.ConnectionBlogger.PageBlogger.PageListBlogger.PagePropertyBlogger.PostBlogger.PostListBlogger.PostPropertyCacheCache.ExpiresCache.GetCache.IsSetCache.SetCache.UnsetCertifyCertify.ConnectionCertify.DepartmentListCertify.DepartmentPropertyCherwellCherwell.BusinessObjectDefinitionListCherwell.BusinessObjectListCherwell.BusinessObjectSchemaCherwell.BusinessObjectSummaryCherwell.ConnectionCiscoCisco.ConnectionCisco.FirmwareVersionPropertyCisco.SecurityAdvisoryListCisco.SerialNumberPropertyCisco.SoftwareSuggestionListCiscoDnaCenterCiscoDnaCenter.ConnectionCiscoDnaCenter.SiteListCiscoDnaCenter.SitePropertyCloudHealthCloudHealth.AssetDetailsCloudHealth.AssetListCloudHealth.AvailableReportDimensionsCloudHealth.AvailableReportOptionsCloudHealth.AvailableReportsListCloudHealth.AwsAccountDetailsCloudHealth.AwsAccountsListCloudHealth.ConnectionCloudHealth.CustomerDetailsCloudHealth.CustomerListCloudHealth.CustomerReportDetailsCloudHealth.CustomerStatementDetailsCloudHealth.OrganisationAccountsListCloudHealth.OrganisationListCloudHealth.QueryConnectWiseManageConnectWiseManage.ConnectionConnectWiseManage.CountConnectWiseManage.DictionaryConnectWiseManage.ListConnectWiseManage.PropertyCoreArrayArray.CountBreakBreakpointCalculateColorCommentContinueConvertDeleteDeleteRowDocumentBookmarkDocumentBreakDocumentInsertSectionDocumentSectionEmailEmailFileEmailReportExecuteForEachFormatTableCellFormatTableRowIfIgnoreIncInsertTableCellImageIsSetLinearRegressionLinkMapObjectRandomRegexRepeatRowSearchAndReplaceSectionSettingsSleepStopStopwatchStringStringIndexSubstringSwitchThrowExceptionUnsetWarningDatabaseDatabase.ConnectionDatabase.GraphDatabase.ListDatabase.TableDatabase.ValueDatabase.ValuesDataMagicDataMagic.SyncDictionaryDictionary.ItemDictionary.KeysDictionary.ValuesDocumentDocument.SetPropertiesFileFile.CopyFile.CopyOutputFilesFile.Csv.CellFile.Csv.RowFile.Csv.RowCountFile.Csv.TableFile.EmbedFile.ExecuteFile.ExistsFile.ImageFile.InsertFile.ListFile.LoadListFile.LoadObjectFile.LoadStringFile.LoadVariablesFile.Xlsx.CellFile.Xlsx.RowFile.Xlsx.RowCountFile.Xlsx.TableFunctionFunction.CallFunction.DefineGoogleGoogle.ConnectionGoogle.TableGraphGraph.AddDataGraph.DeleteDataGraph.RenameDataGraph.UpdateGravatarGravatar.ImageHighlightHighlight.BearerSummaryHighlight.BroadbandSummaryHighlight.CellularSummaryHighlight.ConnectionHighlight.FolderListHighlight.HttpServerPerformanceSummaryHighlight.IcmpTcpUdpPerformanceSummaryHighlight.MosPerformanceSummaryHighlight.PrecisionPerformanceSummaryHighlight.TunnelSummaryHighlight.WatchNodeListHighlight.WirelessAccessPointSummaryHubSpotHubSpot.ListJarrayJarray.TableJiraJira.AttachmentImageJira.AttachmentListJira.AttachmentPropertyJira.ConnectionJira.GraphJira.InsertMarkupJira.IssueAnalysisJira.IssueCommentListJira.IssueCommentPropertyJira.IssueLastCommentPropertyJira.IssueListJira.IssuePropertyJira.IssueResponseTimeJira.LastImageJira.StatusListJira.TableJira.TimeInStateJira.UserListJira.UserPropertyJsonJson.ItemJson.ListKrokiKroki.ImageListList.AddList.AnalysisList.ComplementList.CountList.DequeueList.DuplicatesList.FirstList.GraphList.GroupByList.IndicesOfList.IntersectionList.ItemList.RangeList.SelectList.SelectColumnsList.SortList.SummaryValueList.TableList.UnionList.WhereLogicMonitorLogicMonitor.AccountPropertyLogicMonitor.AlertAnalysisLogicMonitor.AlertCalendarLogicMonitor.AlertCountLogicMonitor.AlertListLogicMonitor.AlertMapLogicMonitor.AlertPropertyLogicMonitor.AlertRuleListLogicMonitor.AlertRulePropertyLogicMonitor.AlertStatusLogicMonitor.AlertTableLogicMonitor.AppliesToFunctionListLogicMonitor.AppliesToFunctionPropertyLogicMonitor.AppliesToListLogicMonitor.AuditEventAnalysisLogicMonitor.BigNumberWidgetValuesLogicMonitor.ClearCacheLogicMonitor.CollectorExecuteLogicMonitor.CollectorGroupListLogicMonitor.CollectorGroupPropertyLogicMonitor.CollectorListLogicMonitor.CollectorPropertyLogicMonitor.CollectorVersionListLogicMonitor.CollectorVersionPropertyLogicMonitor.ConfigCheckListLogicMonitor.ConfigCheckPropertyLogicMonitor.ConfigSourceGroupListLogicMonitor.ConfigSourceListLogicMonitor.ConfigSourcePropertyLogicMonitor.ConfigSourceXmlLogicMonitor.ConnectionLogicMonitor.ConnectionApiTokenLogicMonitor.ConvertToLiveWidgetLogicMonitor.DashboardLogicMonitor.DashboardGroupListLogicMonitor.DashboardGroupPropertyLogicMonitor.DashboardListLogicMonitor.DashboardPropertyLogicMonitor.DashboardWidgetListLogicMonitor.DatamartSyncLogicMonitor.DataPointListLogicMonitor.DataPointPropertyLogicMonitor.DataSourceGraphListLogicMonitor.DataSourceGraphPropertyLogicMonitor.DataSourceGroupListLogicMonitor.DataSourceListLogicMonitor.DataSourcePropertyLogicMonitor.DataSourceXmlLogicMonitor.DeviceConfigSourceFileLogicMonitor.DeviceConfigSourceInstanceListLogicMonitor.DeviceConfigSourceListLogicMonitor.DeviceConfigSourcePropertyLogicMonitor.DeviceCountLogicMonitor.DeviceDataSourceListLogicMonitor.DeviceDataSourcePropertyLogicMonitor.DeviceGroupListLogicMonitor.DeviceGroupPropertyLogicMonitor.DeviceListLogicMonitor.DevicePropertyLogicMonitor.DeviceSlaWidgetPropertyLogicMonitor.DeviceTableLogicMonitor.EscalationChainDestinationListLogicMonitor.EscalationChainDestinationPropertyLogicMonitor.EscalationChainListLogicMonitor.EscalationChainPropertyLogicMonitor.EventSourceFilterListLogicMonitor.EventSourceFilterPropertyLogicMonitor.EventSourceGroupListLogicMonitor.EventSourceListLogicMonitor.EventSourcePropertyLogicMonitor.EventSourceXmlLogicMonitor.FinancialInformationLogicMonitor.ForecastLogicMonitor.GraphLogicMonitor.HistoricSdtListLogicMonitor.ImageLogicMonitor.InstanceAnalysisLogicMonitor.InstanceCountLogicMonitor.InstanceDetailsTableLogicMonitor.InstanceGroupCountLogicMonitor.InstanceGroupListLogicMonitor.InstanceListLogicMonitor.InstancePropertyLogicMonitor.IntegrationListLogicMonitor.IntegrationPropertyLogicMonitor.JobMonitorListLogicMonitor.JobMonitorPropertyLogicMonitor.LastMeasurementLogicMonitor.LogAnalysisLogicMonitor.LogicModuleMetadataPropertyLogicMonitor.LogicModuleUpdateListLogicMonitor.LogicModuleUpdatePropertyLogicMonitor.LogItemListLogicMonitor.NetscanGroupListLogicMonitor.NetscanGroupPropertyLogicMonitor.NetscanListLogicMonitor.NetscanPropertyLogicMonitor.NewUserMessagePropertyLogicMonitor.PaymentInformationLogicMonitor.PercentageAvailabilityLogicMonitor.PortalVersionLogicMonitor.PropertySourceGroupListLogicMonitor.PropertySourceJsonLogicMonitor.PropertySourceListLogicMonitor.PropertySourcePropertyLogicMonitor.QueryLogicMonitor.RecipientGroupListLogicMonitor.RecipientGroupPropertyLogicMonitor.RecycleBinItemListLogicMonitor.RecycleBinItemPropertyLogicMonitor.ReportGroupListLogicMonitor.ReportGroupPropertyLogicMonitor.ReportListLogicMonitor.ReportPropertyLogicMonitor.ResourceAnalysisLogicMonitor.ResourceGroupAnalysisLogicMonitor.RoleListLogicMonitor.RolePropertyLogicMonitor.SdtListLogicMonitor.SdtPercentageLogicMonitor.SdtPropertyLogicMonitor.SingleSignOnPropertyLogicMonitor.SlaWidgetValuesLogicMonitor.SnmpSysOidMapListLogicMonitor.SnmpSysOidMapPropertyLogicMonitor.SummaryValueLogicMonitor.SummaryValueListLogicMonitor.ThresholdLogicMonitor.TrafficTableLogicMonitor.UnmonitoredDeviceListLogicMonitor.UnmonitoredDevicePropertyLogicMonitor.UserApiTokenListLogicMonitor.UserApiTokenPropertyLogicMonitor.UserListLogicMonitor.UserPropertyLogicMonitor.WebsiteCheckpointDataListLogicMonitor.WebsiteCountLogicMonitor.WebsiteGroupAnalysisLogicMonitor.WebsiteGroupCountLogicMonitor.WebsiteGroupListLogicMonitor.WebsiteGroupPropertyLogicMonitor.WebsiteListLogicMonitor.WebsitePropertyLogicMonitor.WidgetStatusMagicSuiteMagicSuite.SubscriptionListMerakiMeraki.CameraImageMeraki.ConfigurationChangeListMeraki.ConnectionMeraki.DevicePropertyMeraki.DeviceUplinkPropertyMeraki.EndOfLifeMeraki.NetworkClientListMeraki.NetworkDeviceListMeraki.NetworkEventListMeraki.NetworkListMeraki.NetworkPropertyMeraki.NetworkSwitchPortsListMeraki.NetworkSwitchStackListMeraki.OrganizationDeviceLicenseListMeraki.OrganizationDeviceLicensePropertyMeraki.OrganizationDeviceListMeraki.OrganizationDeviceListStatusPropertyMeraki.OrganizationInventoryListMeraki.OrganizationLicenseStatePropertyMeraki.OrganizationListMeraki.OrganizationPropertyMeraki.OrganizationUplinkUsageMeraki.WirelessNetworkClientConnectionStatsPropertyMeraki.WirelessNetworkClientLatencyListMeraki.WirelessNetworkClientsConnectionStatsListMeraki.WirelessNetworkClientsLatencyListMeraki.WirelessNetworkConnectionStatsPropertyMeraki.WirelessNetworkDeviceConnectionStatsPropertyMeraki.WirelessNetworkDeviceLatencyListMeraki.WirelessNetworkDevicesConnectionStatsListMeraki.WirelessNetworkDevicesLatencyListMeraki.WirelessNetworkLatencyListMicrosoftDataverseMicrosoftDataverse.ConnectionMicrosoftDataverse.CountMicrosoftDataverse.EntityDefinitionsListMicrosoftDataverse.EntityListMicrosoftDataverse.EntityPropertyListMicrosoftDataverse.ListMicrosoftDataverse.PropertyMicrosoftGraphMicrosoftGraph.ConnectionMicrosoftGraph.MicrosoftDataverseConnectionMicrosoftGraph.QueryObjectObject.ArrayCountObject.PropertyObject.TypeObject.UnpackObject.UnpackVariablesOpenAiOpenAi.AnswerOpenAi.CompleteOpenAi.ConnectionOpenAi.ImageQuickBooksQuickBooks.ConnectionQuickBooks.PropertyReportMagicReportMagic.ApplyBrandReportMagic.BadgeListReportMagic.ConnectionListReportMagic.ConnectionPropertyReportMagic.ConnectionStatusPropertyReportMagic.FeedbackListReportMagic.FeedbackPropertyReportMagic.MacroGroupListReportMagic.MacroHelpReportMagic.MacroListReportMagic.ReportBatchJobCountReportMagic.ReportBatchJobListReportMagic.ReportBatchJobPropertyReportMagic.ReportConnectionSummaryReportMagic.ReportJobCountReportMagic.ReportJobListReportMagic.ReportJobPropertyReportMagic.ReportMacroCountReportMagic.ReportPropertyReportMagic.ReportScheduleCountReportMagic.ReportScheduleListReportMagic.ReportSchedulePropertyReportMagic.SetReportPropertyReportMagic.SystemPropertyReportMagic.TenantImageReportMagic.TopicHelpReportMagic.VersionSalesforceSalesforce.ConnectionSalesforce.ListSalesforce.PropertyServiceNowServiceNow.ConnectionServiceNow.CountServiceNow.CreateServiceNow.DeleteServiceNow.DictionaryServiceNow.ListServiceNow.PropertyServiceNow.UpdateShapeShape.AddShape.CloneShape.DeleteShape.FormatShape.HideShape.SetPropertyShape.SetTextSlackSlack.ConnectionSlack.MessageSlideSlide.DeleteSlide.DeleteSectionSlide.LinkSlide.MoveToSlide.RepeatSmtpSmtp.ConnectionSnmpSnmp.EnterprisePropertySolarWindsSolarWinds.ConnectionSolarWinds.SqlListSolarWinds.SqlTableSqlSql.AnalysisTableTable.ColumnCountTable.DeleteTable.FormatTable.GraphTable.MergeCellsTable.RowCountTable.SaveTable.SortTable.WorldMapTimeCalendarCronHumanReadableCronRunDateDateRangeDateTimeDateTime.IsInWorkHoursDateTime.WorkHoursDurationTimeSpanTogglToggl.ClientListToggl.ClientPropertyToggl.ConnectionToggl.ProjectListToggl.ProjectPropertyToggl.ProjectReportPropertyToggl.TimeEntryListToggl.TimeEntryPropertyToggl.UserListToggl.UserPropertyToggl.WorkspaceListToggl.WorkspacePropertyTwilioTwilio.ConnectionTwilio.SmsUkParliamentUkParliament.PetitionCountUkParliament.PetitionListUkParliament.PetitionPropertyVariableVariable.ImageVariable.ListVariable.PropertyWebWeb.ConnectionWeb.HtmlWeb.ImageWeb.QueryWeb.ScreenshotWeb.TableWeb.TextXlsxXlsx.AddAnalysisXlsx.EmbedZendeskZendesk.ConnectionZendesk.ListZendesk.PropertyZoho.DeskZoho.Desk.ZohoListZoho.Desk.ZohoProperty

[LogicMonitor.DeviceTable:]

Inserts a table containing summary device data into your report.


Purpose

Inserts a table containing summary device data into your report. This works for device configurations that were present in LogicMonitor at the time the report was run. Columns can be selected based on standard device properties.


Macro Compatibility

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


Usage

If the columns parameter is not specified, the following will be used:

  • HostName
  • DisplayedAs
  • Type
  • Status

The full list of supported columns are as follows. For more details, see the LogicMonitor API documentation.

  • AllAsJson
  • Id
  • Link
  • HostName
  • NetflowCollectorId
  • PreferredCollectorId
  • CollectorDescription
  • EnableNetflow
  • DisplayName
  • DisplayedAs
  • Type
  • AlertStatus
  • Status
  • AlertsAreAcknowledged
  • AlertLevel
  • AlertsAreInSdt
  • DeviceGroupIds
  • CurrentCollectorId
  • AlertEnable
  • AutoPropsAssignedOn
  • AutoPropsUpdatedOn
  • CreatedOn
  • EffectiveAlertEnabled
  • DeviceGroups
  • Groups
  • InSdt
  • SdtStatus
  • LastDataTime
  • DeviceStatus
  • AllAsJObject
  • Any LogicMonitor device property, preceded with "Properties." (e.g. Properties.system.sysinfo, Properties.ips, Properties.location)
  • Special SysInfo Properties (Cisco only):
    • Properties.system.sysinfo.Hardware
    • Properties.system.sysinfo.Software
    • Properties.system.sysinfo.SoftwareVersion
    • Properties.system.sysinfo.SoftwareStatus

See also Table Macros help.


Parameter TypeDeprecation Message Preferred ParameterPresence Purpose Options Default
alignment
List<String>DeprecatedcolumnAlignments The column alignments. If fewer alignments are made than the number of columns, the last given value is used for the remaining columns. If omitted, no change is made. Supported values: Left, Right and Center. Usage: columnAlignments=Left;Right;Center;...In Excel output files, columns may be automatically aligned based on their type (e.g. numbers are always right-justified), and all column headers are ALWAYS left-justified so their text is not obscured by filter drop-down arrows in the Excel UI. N/A N/A
alignments
List<String>DeprecatedcolumnAlignments The column alignments. If fewer alignments are made than the number of columns, the last given value is used for the remaining columns. If omitted, no change is made. Supported values: Left, Right and Center. Usage: columnAlignments=Left;Right;Center;...In Excel output files, columns may be automatically aligned based on their type (e.g. numbers are always right-justified), and all column headers are ALWAYS left-justified so their text is not obscured by filter drop-down arrows in the Excel UI. N/A N/A
autofit
AutoFitBehaviorDeprecatedautoFit The Word autofit behaviour. If omitted, no change is made.
  • Content
  • Fixed
  • Window
Content
autoFit
AutoFitBehavior

Use instead of:

  • autofit
Optional The Word autofit behaviour. If omitted, no change is made.
  • Content
  • Fixed
  • Window
Content
calculate
StringOptional Post processing formula. Use {value} for the macro output, e.g. {value}/1024. N/A N/A
colorTableCell
BooleanOptional Whether to color table cells if thresholds are breached, rather than color the text.
  • true
  • false
true
columnAlignments
List<String>

Use instead of:

  • alignment
  • alignments
Optional The column alignments. If fewer alignments are made than the number of columns, the last given value is used for the remaining columns. If omitted, no change is made. Supported values: Left, Right and Center. Usage: columnAlignments=Left;Right;Center;...In Excel output files, columns may be automatically aligned based on their type (e.g. numbers are always right-justified), and all column headers are ALWAYS left-justified so their text is not obscured by filter drop-down arrows in the Excel UI. N/A N/A
columns
List<String>Optional The column names to show. If the columns parameter is not specified, the Macro's default will be used. N/A N/A
comment
StringOptional Add a comment to make your document template more readable. The comment is discarded in the output document. N/A N/A
connectionName
StringOptional The name of the LogicMonitor Connection. N/A N/A
createdBefore
DateTimeOffsetOptional Only include devices that were created before this time (UTC). N/A N/A
criticalAfter
DateTimeOffsetOptional The macro is considered 'critical' if the output is after this DateTime UTC. N/A N/A
criticalBefore
DateTimeOffsetOptional The macro is considered 'critical' if the output is before this DateTime UTC. N/A N/A
criticalCellColor
ColorOptional The critical cell background color to use. If omitted, no change is made. Affects a cell or row based on the ThresholdAffects parameter. Color [A=255, R=192, G=0, B=0]
criticalCellTextColor
ColorOptional The critical cell text color to use. If omitted, no change is made. Affects a cell or row based on the ThresholdAffects parameter. N/A
criticalEq
StringOptional The macro is considered 'critical' if the output is equal to this value. N/A N/A
criticalFontBackgroundColor
ColorOptional The critical font background color to use. If omitted, no change is made. N/A
criticalFontBold
BooleanOptional Change the font weight (true=strong, false=normal). If omitted, no change is made.
  • true
  • false
N/A
criticalFontColor
ColorOptional The critical font color to use. If omitted, no change is made. N/A
criticalFontSize
DoubleOptional Change the critical font size in points. If omitted, no change is made.
  • From 2 to 200
N/A
criticalGe
StringOptional The macro is considered 'critical' if the output is greater than or equal to this value. N/A N/A
criticalGt
StringOptional The macro is considered 'critical' if the output is greater than this value. N/A N/A
criticalIf
StringOptional 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
StringOptional The macro is considered 'critical' if the output is less than or equal to this value. N/A N/A
criticalLt
StringOptional The macro is considered 'critical' if the output is less than this value. N/A N/A
criticalNe
StringOptional The macro is considered 'critical' if the output is not equal to this value. N/A N/A
criticalTableCellBackgroundColor
ColorOptional The critical table cell background color to use. N/A
dataSourceExists
StringOptional 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
StringOptional 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
StringOptional 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
StringOptional 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
dateTimeFormat
StringOptional The date/time format to use. Use the format specified here: https://docs.microsoft.com/en-us/dotnet/standard/base-types/custom-date-and-time-format-strings. When the format parameter is set to AllStrings, this is ignored unless you use NumbersAsStrings. Note however that this parameter only has an effect if all the values in the column are the same type. N/A yyyy-MM-dd
deCamelCaseHeaderRow
BooleanOptional Whether to de-camel-case the header row (i.e. convert 'MyHeaderText' to 'My Header Text'.
  • true
  • false
false
delimiter
CharOptional The delimiter to use between multiple items in the output. N/A ;
deviceGroup
List<String>

Use instead of:

  • deviceGroups
  • group
  • groups
Optional The Device Group or Device Groups (semi-colon separated). Use "/" or no value to reference the root folder. N/A /
deviceGroups
List<String>DeprecateddeviceGroup The Device Group or Device Groups (semi-colon separated). Use "/" or no value to reference the root folder. N/A /
emptyTableText
StringOptional If present, and the table has no rows, the specified text will be inserted in place of the table. N/A N/A
errorAfter
DateTimeOffsetOptional The macro is considered 'error' if the output is after this DateTime UTC. N/A N/A
errorBefore
DateTimeOffsetOptional The macro is considered 'error' if the output is before this DateTime UTC. N/A N/A
errorCellColor
ColorOptional The error cell background color to use. If omitted, no change is made. Affects a cell or row based on the ThresholdAffects parameter. Color [A=255, R=240, G=128, B=0]
errorCellTextColor
ColorOptional The error cell text color to use. If omitted, no change is made. Affects a cell or row based on the ThresholdAffects parameter. N/A
errorEq
StringOptional The macro is considered 'error' if the output is equal to this value. N/A N/A
errorFontBackgroundColor
ColorOptional The error font background color to use. If omitted, no change is made. N/A
errorFontBold
BooleanOptional Change the error font weight (true=strong, false=normal). If omitted, no change is made.
  • true
  • false
N/A
errorFontColor
ColorOptional The error font color to use. If omitted, no change is made. N/A
errorFontSize
DoubleOptional Change the error font size in points. If omitted, no change is made.
  • From 2 to 200
N/A
errorGe
StringOptional The macro is considered 'error' if the output is greater than or equal to this value. N/A N/A
errorGt
StringOptional The macro is considered 'error' if the output is greater than this value. N/A N/A
errorIf
StringOptional 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
StringOptional The macro is considered 'error' if the output is less than or equal to this value. N/A N/A
errorLt
StringOptional The macro is considered 'error' if the output is less than this value. N/A N/A
errorNe
StringOptional The macro is considered 'error' if the output is not equal to this value. N/A N/A
errorOnOverflow
BooleanOptional Should NCalc expression evaluation throw error on Overflow
  • true
  • false
true
errorTableCellBackgroundColor
ColorOptional The error table cell background color to use. N/A
failureText
StringOptional 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
DateTimeOffsetOptional The macro is considered 'fatal' if the output is after this DateTime UTC. N/A N/A
fatalBefore
DateTimeOffsetOptional The macro is considered 'fatal' if the output is before this DateTime UTC. N/A N/A
fatalCellColor
ColorOptional The fatal cell background color to use. If omitted, no change is made. Affects a cell or row based on the ThresholdAffects parameter. Color [A=255, R=150, G=0, B=0]
fatalCellTextColor
ColorOptional The fatal cell text color to use. If omitted, no change is made. Affects a cell or row based on the ThresholdAffects parameter. N/A
fatalEq
StringOptional The macro is considered 'fatal' if the output is equal to this value. N/A N/A
fatalFontBackgroundColor
ColorOptional The fatal font background color to use. If omitted, no change is made. N/A
fatalFontBold
BooleanOptional Change the fatal font weight (true=strong, false=normal). If omitted, no change is made.
  • true
  • false
N/A
fatalFontColor
ColorOptional The fatal font color to use. If omitted, no change is made. N/A
fatalFontSize
DoubleOptional Change the fatal font size in points. If omitted, no change is made.
  • From 2 to 200
N/A
fatalGe
StringOptional The macro is considered 'fatal' if the output is greater than or equal to this value. N/A N/A
fatalGt
StringOptional The macro is considered 'fatal' if the output is greater than this value. N/A N/A
fatalIf
StringOptional 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
StringOptional The macro is considered 'fatal' if the output is less than or equal to this value. N/A N/A
fatalLt
StringOptional The macro is considered 'fatal' if the output is less than this value. N/A N/A
fatalNe
StringOptional The macro is considered 'fatal' if the output is not equal to this value. N/A N/A
fatalTableCellBackgroundColor
ColorOptional The fatal table cell background color to use. N/A
filter
StringOptional For advanced filtering, use the LogicMonitor API's filtering system. This feature is only supported through professional services. N/A N/A
filterProperty
StringOptional 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
TildaOptionStringOptional 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
fontBackgroundColor
ColorOptional The font background color to use. N/A
fontBold
BooleanOptional Change the font weight (true=strong, false=normal). If omitted, no change is made.
  • true
  • false
N/A
fontColor
ColorOptional The font color to use. N/A
fontSize
DoubleOptional Override the table style's font size. This is achieved by setting the font size for each table cell.
  • From 4 to 50
N/A
format
CellFormatOptional The cell format to use. Options are: 'AllStrings', 'Auto' or 'NumbersAsStrings'. Auto automatically sets the format for the whole column, or it can be forced to a string with AllStrings. To preserve date / time formatting (with dateTimeFormat) but treat only number columns as strings, use NumbersAsStrings.
  • Auto
  • AllStrings
  • NumbersAsStrings
Auto
group
List<String>DeprecateddeviceGroup The Device Group or Device Groups (semi-colon separated). Use "/" or no value to reference the root folder. N/A /
groups
List<String>DeprecateddeviceGroup The Device Group or Device Groups (semi-colon separated). Use "/" or no value to reference the root folder. N/A /
hidden
BooleanOptional If true, the table will not be written to the report.
  • true
  • false
false
horizontalAlignment
TableHorizontalAlignmentOptional The horizontal alignment of the table on the page (does not affect Excel output).
  • Left
  • Center
  • Right
Left
if
StringOptional 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
includeCondition
StringOptional The condition on which each row is included. Fields should be referred to based on the column name in curly braces, for example: includeCondition ='{CreatedOn}'>'{StartOfLastMonth}'. N/A N/A
infoAfter
DateTimeOffsetOptional The macro is considered 'info' if the output is after this DateTime UTC. N/A N/A
infoBefore
DateTimeOffsetOptional The macro is considered 'info' if the output is before this DateTime UTC. N/A N/A
infoCellColor
ColorOptional The info cell background color to use. If omitted, no change is made. Affects a cell or row based on the ThresholdAffects parameter. Color [A=255, R=0, G=213, B=213]
infoCellTextColor
ColorOptional The info cell text color to use. If omitted, no change is made. Affects a cell or row based on the ThresholdAffects parameter. N/A
infoEq
StringOptional The macro is considered 'info' if the output is equal to this value. N/A N/A
infoFontBackgroundColor
ColorOptional The info font background color to use. If omitted, no change is made. N/A
infoFontBold
BooleanOptional Change the info font weight (true=strong, false=normal). If omitted, no change is made.
  • true
  • false
N/A
infoFontColor
ColorOptional The info font color to use. If omitted, no change is made. N/A
infoFontSize
DoubleOptional Change the info font size in points. If omitted, no change is made.
  • From 2 to 200
N/A
infoGe
StringOptional The macro is considered 'info' if the output is greater than or equal to this value. N/A N/A
infoGt
StringOptional The macro is considered 'info' if the output is greater than this value. N/A N/A
infoIf
StringOptional 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
StringOptional The macro is considered 'info' if the output is less than or equal to this value. N/A N/A
infoLt
StringOptional The macro is considered 'info' if the output is less than this value. N/A N/A
infoNe
StringOptional The macro is considered 'info' if the output is not equal to this value. N/A N/A
infoTableCellBackgroundColor
ColorOptional The info table cell background color to use. N/A
instanceCountEq
Int32Optional 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
Int32Optional 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
Int32Optional 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
Int32Optional 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
Int32Optional 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
Int32Optional 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
BooleanOptional When specified only brings back DeviceGroups where the alerting is/is not enabled
  • true
  • false
N/A
matchAppliesToQuery
StringOptional 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
maxAttempts
Int32Optional The maximum number of attempts when requesting data via the LogicMonitor API.
  • From 1 to 2147483647
N/A
mode
MacroModeOptional 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
normalCellColor
ColorOptional The cell color to use when no issue exists. Affects a cell or row based on the ThresholdAffects parameter. N/A
normalCellTextColor
ColorOptional The cell text color to use when no issue exists. Affects a cell or row based on the ThresholdAffects parameter. N/A
normalFontBackgroundColor
ColorOptional The normal font background color to use. If omitted, no change is made. N/A
normalFontBold
BooleanOptional Change the normal font weight (true=strong, false=normal). If omitted, no change is made.
  • true
  • false
N/A
normalFontColor
ColorOptional The normal font color to use. If omitted, no change is made. N/A
normalFontSize
DoubleOptional Change the normal font size in points. If omitted, no change is made.
  • From 2 to 200
N/A
normalTableCellBackgroundColor
ColorOptional The normal table cell background color to use. If omitted, no change is made. N/A
obfuscation
ObfuscationTypeOptional 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
StringOptional If present, sorts alphanumerically by this column. N/A N/A
orderByDescending
StringOptional If present, sorts reverse alphanumerically by this column. N/A N/A
outputListsAsJarray
Normal mode
BooleanOptional Any macros that output lists can optionally (in Normal mode) output a jArray instead.
  • true
  • false
true
pageWidthPercent
DoubleOptional The percentage of the available page that the table should occupy.
  • From 0 to 150
N/A
property
StringOptional 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
recurseDeviceGroup
BooleanDeprecatedrecurseDeviceGroups Include devices in all child folders.
  • true
  • false
true
recurseDeviceGroups
Boolean

Use instead of:

  • recurseDeviceGroup
Optional Include devices in all child folders.
  • true
  • false
true
redact
BooleanOptional 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
repeatHeaderPerPage
BooleanOptional Whether to repeat the header row at the beginning of each page.
  • true
  • false
true
selectDistinct
BooleanOptional Eliminate duplicates if set to true.
  • true
  • false
false
singleValueList
Normal mode
BooleanOptional 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
status
StringOptional Only include devices in this status. Supported values: Dead and Normal. N/A N/A
storeAs
StringOptional The variable to store the result as. N/A N/A
storeAsHidden
StringOptional The variable to store the result as, while hiding the output. Equivalent to 'storeAs=ThisValue, hidden=true'. N/A N/A
storeAsVariableDelimiter
CharOptional 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 ;
storeFormattedValueAs
StringOptional 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
style
StringOptional Use Word's built in Table Styles (such as Grid Table 2 - Accent 1), or make your own in the Report Template. Built-in styles can be used in any document. Note that any custom styles you create, or customisations to the standard styles required that the styles exist in the input template XML (because they are not saved in Word documents by default). This can be achieved by assigning the style to a table, then delete the table and save the document. N/A Table Grid
tableName
StringOptional The table name (e.g. for XLSX output) N/A Table
take
Int32

Use instead of:

  • topN
Optional Only display up to this number of rows.
  • From 0 to 2147483647
N/A
thresholdAffects
ThresholdAffectsOptional What the threshold affects.
  • Cell
  • Row
Cell
thresholdColumn
StringOptional The threshold column. N/A N/A
topN
Int32Deprecatedtake Only display up to this number of rows.
  • From 0 to 2147483647
N/A
type
DeviceListTypeOptional Whether to include Devices, Services, or both.
  • Device
  • Service
  • All
Device
waitDuringUpgrades
BooleanOptional Whether to wait during LogicMonitor upgrades (i.e. execution essentially pauses).
  • true
  • false
N/A
warning
StringOptional 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
DateTimeOffsetOptional The macro is considered 'warning' if the output is after this DateTime UTC. N/A N/A
warningBefore
DateTimeOffsetOptional The macro is considered 'warning' if the output is before this DateTime UTC. N/A N/A
warningCellColor
ColorOptional The warning cell background color to use. If omitted, no change is made. Affects a cell or row based on the ThresholdAffects parameter. Color [A=255, R=240, G=192, B=0]
warningCellTextColor
ColorOptional The warning cell text color to use. If omitted, no change is made. Affects a cell or row based on the ThresholdAffects parameter. N/A
warningEq
StringOptional The macro is considered 'warning' if the output is equal to this value. N/A N/A
warningFontBackgroundColor
ColorOptional The warning font background color to use. If omitted, no change is made. N/A
warningFontBold
BooleanOptional Change the warning font weight (true=strong, false=normal). If omitted, no change is made.
  • true
  • false
N/A
warningFontColor
ColorOptional The warning font color to use. If omitted, no change is made. N/A
warningFontSize
DoubleOptional Change the warning font size in points. If omitted, no change is made.
  • From 2 to 200
N/A
warningGe
StringOptional The macro is considered 'warning' if the output is greater than or equal to this value. N/A N/A
warningGt
StringOptional The macro is considered 'warning' if the output is greater than this value. N/A N/A
warningIf
StringOptional 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
StringOptional The macro is considered 'warning' if the output is less than or equal to this value. N/A N/A
warningLt
StringOptional The macro is considered 'warning' if the output is less than this value. N/A N/A
warningNe
StringOptional The macro is considered 'warning' if the output is not equal to this value. N/A N/A
warningTableCellBackgroundColor
ColorOptional The warning table cell background color to use. N/A
worksheetName
StringOptional The worksheet to save the result in the output Excel document (if so configured). Excel does not allow blank names, names above 31 characters, and the following characters: :, /, \, ?, *, [, ] N/A Table
writeToSpreadsheet
BooleanOptional Whether to output the result in the output Excel document (if so configured).
  • true
  • false
true
xlsxTableStyle
XlsxTableStyleOptional The XLSX table style to use in any XLSX output document.
  • TableStyleMedium13
  • None
  • TableStyleDark1
  • TableStyleDark10
  • TableStyleDark11
  • TableStyleDark2
  • TableStyleDark3
  • TableStyleDark4
  • TableStyleDark5
  • TableStyleDark6
  • TableStyleDark7
  • TableStyleDark8
  • TableStyleDark9
  • TableStyleLight1
  • TableStyleLight10
  • TableStyleLight11
  • TableStyleLight12
  • TableStyleLight13
  • TableStyleLight14
  • TableStyleLight15
  • TableStyleLight16
  • TableStyleLight17
  • TableStyleLight18
  • TableStyleLight19
  • TableStyleLight2
  • TableStyleLight20
  • TableStyleLight21
  • TableStyleLight3
  • TableStyleLight4
  • TableStyleLight5
  • TableStyleLight6
  • TableStyleLight7
  • TableStyleLight8
  • TableStyleLight9
  • TableStyleMedium1
  • TableStyleMedium10
  • TableStyleMedium11
  • TableStyleMedium12
  • TableStyleMedium14
  • TableStyleMedium15
  • TableStyleMedium16
  • TableStyleMedium17
  • TableStyleMedium18
  • TableStyleMedium19
  • TableStyleMedium2
  • TableStyleMedium20
  • TableStyleMedium21
  • TableStyleMedium22
  • TableStyleMedium23
  • TableStyleMedium24
  • TableStyleMedium25
  • TableStyleMedium26
  • TableStyleMedium27
  • TableStyleMedium28
  • TableStyleMedium3
  • TableStyleMedium4
  • TableStyleMedium5
  • TableStyleMedium6
  • TableStyleMedium7
  • TableStyleMedium8
  • TableStyleMedium9
TableStyleMedium13

Examples (4)

Example 1:
[LogicMonitor.DeviceTable: deviceGroup=PDL - Panoramic Data/Datacenter, columns=HostName;Description;Properties, style=Grid Table 5 Dark - Accent 4, autoFit=Window]

Example 2:
[LogicMonitor.DeviceTable: deviceGroup=PDL - Panoramic Data, columns=HostName;DisplayedAs;Type;Status;AlertsAreAcknowledged;AlertLevel;AlertsAreInSdt]

Example 3:

Only include devices currently in an error state

[LogicMonitor.DeviceTable: deviceGroup=PDL - Panoramic Data, columns=HostName;DisplayedAs;Type;Status;AlertsAreAcknowledged;AlertLevel;AlertsAreInSdt, includeCondition=`'{AlertLevel}' == 'Error'`]

Example 4:

Inserts a table of recently-added devices per top-level device group. See also the 'LogicMonitor Recently Added Devices' Report in the Report Template Library

[DateTime:storeAs=StartOfThisMonth, format=yyyy-MM-01, hidden=true]
Devices added after [DateTime:value={StartOfThisMonth},addMonths=-1,storeAs=StartOfLastMonth]
[Settings: LogicMonitor.DeviceTable.style=Grid Table 4 - Accent 2, LogicMonitor.DeviceTable.autoFit=Window, LogicMonitor.DeviceTable.columns=HostName;CreatedOn, LogicMonitor.DeviceTable.orderByDescending=CreatedOn]
[LogicMonitor.DeviceGroupList: storeAs=TopLevelGroups, deviceGroup=/, hidden=true]
[ForEach: values={TopLevelGroups}, storeAs=CurrentGroup]
Device Group: [String: value={CurrentGroup}]
[LogicMonitor.DeviceTable: deviceGroup={CurrentGroup}, recurseDeviceGroups=true, includeCondition = '{CreatedOn}'>'{StartOfLastMonth}', emptyTableText=No recently-added devices.]
[ForEachEnd:]
An unhandled error has occurred. Reload 🗙