ReportMagic

[LogicMonitor.InstanceGroupList:]

Lists the Instance Groups of the specified DataSource.

Purpose

Lists the Instance Groups of the specified DataSource, whether those groups are manually or automatically created.

Macro Compatibility

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

Parameter	Type	Deprecation Message	Preferred Parameter	Presence	Purpose	Options	Default
dataSource	String	Deprecated	dataSourceName		The DataSource unique name.	N/A	N/A
dataSourceName	String	Use instead of: dataSource		Mandatory	The DataSource unique name.	N/A	N/A
dataSourceInstanceGroupId	Int32			Conditional	The DataSource instance group id. If set, the dataSource parameter must also be set.	N/A	N/A
dataSourceInstanceGroupName	String			Conditional	The DataSource instance group name. If set, the dataSource parameter must also be set.	N/A	N/A
dataSourceInstanceId	Int32			Conditional	The DataSource instance ID. If set, the dataSource parameter must also be set.	N/A	N/A
dataSourceInstanceName	String			Conditional	The DataSource instance name. If set, the dataSource parameter must also be set.	N/A	N/A
graphId	Int32			Conditional	The graph ID. If set, do not set the 'graphName' parameter. You can use -1 to use raw data when there is no graph in LogicMonitor but you must choose the data point name as it appears on the 'Raw Data' tab in LogicMonitor, rather than the name in the DataPoint definition.	N/A	N/A
graphName	String			Conditional	The graph name. If set, do not set the 'graphId' parameter.	N/A	N/A
overviewGraphId	Int32			Conditional	The overview graph ID.	N/A	N/A
overviewGraphName	String			Conditional	The overview graph name.	N/A	N/A
serviceCheckPointName	List<String>	Deprecated	websiteCheckPointName		The website checkpoint name or names (required when type is set to WebsiteCheckPoint).	N/A	N/A
serviceCheckPointNames	List<String>	Deprecated	websiteCheckPointName		The website checkpoint name or names (required when type is set to WebsiteCheckPoint).	N/A	N/A
serviceName	List<String>	Deprecated	websiteName		The website name or names (required when type is set to WebsiteOverview or WebsiteCheckPoint).	N/A	N/A
serviceNames	List<String>	Deprecated	websiteName		The website name or names (required when type is set to WebsiteOverview or WebsiteCheckPoint).	N/A	N/A
websiteCheckPointName	List<String>	Use instead of: serviceCheckPointName serviceCheckPointNames websiteCheckPointNames		Conditional	The website checkpoint name or names (required when type is set to WebsiteCheckPoint).	N/A	N/A
websiteCheckPointNames	List<String>	Deprecated	websiteCheckPointName		The website checkpoint name or names (required when type is set to WebsiteCheckPoint).	N/A	N/A
websiteName	List<String>	Use instead of: serviceName serviceNames websiteNames		Conditional	The website name or names (required when type is set to WebsiteOverview or WebsiteCheckPoint).	N/A	N/A
websiteNames	List<String>	Deprecated	websiteName		The website name or names (required when type is set to WebsiteOverview or WebsiteCheckPoint).	N/A	N/A
widgetId	Int32			Conditional	The Widget id for dashboard graphs. The type parameter should be set to DashboardWidget. Finding the Widget id requires a few steps: you will need to use your LogicMonitor portal UI, enter developer mode in the browser, and find all 'li' elements (which are the Widgets) where the 'data_component_unique_name' attribute is like xxx_widget_xxx, where xxx are numbers. For example, 99_widget_123 is a Widget id of 123.	N/A	N/A
auto	Boolean			Optional	If 'true', the reporting period will be the last calendar month and neither startDate nor endDate parameters may be used.	true false	false
autoTitle	Boolean			Optional	Whether to auto title the graph.	true false	true
autoTitleHeadingLevel	Int32	Deprecated	titleHeadingLevel		If auto-titling the graph, the heading level to use.	From 1 to 6	N/A
calculate	String			Optional	Post processing formula. Use {value} for the macro output, e.g. {value}/1024.	N/A	N/A
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
dataSourceId	Int32			Optional	The DataSource ID.	N/A	N/A
device	List<String>	Deprecated	devices		The Device Display name or names.	N/A	N/A
deviceDelimiter	Char			Optional	The delimiter to use between each Device's Instance Groups in the output.	N/A	\|
deviceGroup	List<String>	Deprecated	deviceGroups		The Device Group or Groups. Use "/" or no value in the deviceGroup parameter to reference the root folder.	N/A	N/A
deviceGroups	List<String>	Use instead of: deviceGroup group groups		Optional	The Device Group or Groups. Use "/" or no value in the deviceGroup parameter to reference the root folder.	N/A	N/A
deviceId	List<Int32>	Deprecated	deviceIds		The Device ID or IDs.	N/A	N/A
deviceIds	List<Int32>	Use instead of: deviceId hostId		Optional	The Device ID or IDs.	N/A	N/A
devices	List<String>	Use instead of: device host hosts		Optional	The Device Display name or names.	N/A	N/A
endDate	DateTimeOffset			Optional	The end date in the format YYYY-MM-DD.	N/A	Midnight on the first day of this month
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
excludeDataPoint	List<String>			Optional	The datapoints to exclude.	N/A	N/A
excludeSdt	Boolean			Optional	Whether to exclude periods of SDT from the macro results. Only works for Devices (not Websites, etc.). For the most accurate results, ensure that you have LogicMonitor permissions for ALL the Device Groups that the Devices are members of. When this is not the case, those Device Groups will simply be skipped.	true false	false
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
flowDirection	Flows.FlowDirection			Optional	The traffic flow direction. Used only with type=NetflowBandwidth.	All In Out	All
flowInterfaceIndices	List<String>			Optional	The traffic flow interfaces e.g. 1;2;3 for interfaces 1, 2 and 3. Used only with type=NetflowBandwidth.	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
forecast	Boolean			Optional	Whether to include forecast data.	true false	false
forecastTime	String			Optional	The time to forecast.	7days 14days 1month 3months	7days
forecastTrainingTime	String			Optional	The amount of data to use to inform the forecast.	1month 1year 3months 6months	1month
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
graphType	GraphType	Deprecated	type		The graph type. Defaults to Device. Options are: Device, WebsiteOverview, NetflowBandwidth, WebsiteCheckPoint and DashboardWidget.	Device WebsiteOverview NetflowBandwidth WebsiteCheckPoint DashboardWidget	Device
group	List<String>	Deprecated	deviceGroups		The Device Group or Groups. Use "/" or no value in the deviceGroup parameter to reference the root folder.	N/A	N/A
groups	List<String>	Deprecated	deviceGroups		The Device Group or Groups. Use "/" or no value in the deviceGroup parameter to reference the root folder.	N/A	N/A
hidden	Boolean			Optional	Whether to hide the macro output.	true false	false
host	List<String>	Deprecated	devices		The Device Display name or names.	N/A	N/A
hostId	List<Int32>	Deprecated	deviceIds		The Device ID or IDs.	N/A	N/A
hosts	List<String>	Deprecated	devices		The Device Display name or names.	N/A	N/A
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
includeDataPoint	List<String>			Optional	The datapoints to include.	N/A	N/A
infoAfter	DateTimeOffset			Optional	The macro is considered 'info' if the output is after this DateTime UTC.	N/A	N/A
infoBefore	DateTimeOffset			Optional	The macro is considered 'info' if the output is before this DateTime UTC.	N/A	N/A
infoEq	String			Optional	The macro is considered 'info' if the output is equal to this value.	N/A	N/A
infoFontBackgroundColor	Color			Optional	The info font background color to use. If omitted, no change is made.	A named color or an HTML-encoded color .Note that 'transparent' is a valid color that you can use in any macro parameter that expects a color.	N/A
infoFontBold	Boolean			Optional	Change the info font weight (true=strong, false=normal). If omitted, no change is made.	true false	N/A
infoFontColor	Color			Optional	The info font color to use. If omitted, no change is made.	A named color or an HTML-encoded color .Note that 'transparent' is a valid color that you can use in any macro parameter that expects a color.	N/A
infoFontSize	Double			Optional	Change the info font size in points. If omitted, no change is made.	From 2 to 200	N/A
infoGe	String			Optional	The macro is considered 'info' if the output is greater than or equal to this value.	N/A	N/A
infoGt	String			Optional	The macro is considered 'info' if the output is greater than this value.	N/A	N/A
infoIf	String			Optional	The macro is considered 'info' if the expression evaluates to true. Use 'value' as the macro output in the expression.	N/A	N/A
infoLe	String			Optional	The macro is considered 'info' if the output is less than or equal to this value.	N/A	N/A
infoLt	String			Optional	The macro is considered 'info' if the output is less than this value.	N/A	N/A
infoNe	String			Optional	The macro is considered 'info' if the output is not equal to this value.	N/A	N/A
infoTableCellBackgroundColor	Color			Optional	The info table cell background color to use.	A named color or an HTML-encoded color .Note that 'transparent' is a valid color that you can use in any macro parameter that expects a color.	N/A
listDelimiter	Char			Optional	The delimiter to use between multiple Instance Groups 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
maximumInstanceCount	Int32			Optional	Only include Instance Groups with an instance count or this number or fewer.	N/A	2147483647
minimumInstanceCount	Int32			Optional	Only include Instance Groups with an instance count of this number or more.	N/A	0
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
monthsToReport	Int32			Optional	If set, sets 'endDate' to the 'start' plus the specified number of months.	N/A	N/A
normalFontBackgroundColor	Color			Optional	The normal font background color to use. If omitted, no change is made.	A named color or an HTML-encoded color .Note that 'transparent' is a valid color that you can use in any macro parameter that expects a color.	N/A
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
outputListsAsJarray Normal mode	Boolean			Optional	Any macros that output lists can optionally (in Normal mode) output a jArray instead.	true false	true
recurseDeviceGroups	Boolean			Optional	Whether to recurse Device Groups. Specify false to exclude child Device Groups.	true false	true
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
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
startDate	DateTimeOffset			Optional	The start date in the format YYYY-MM-DD.	N/A	Midnight on the first day of last month
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
titleHeadingLevel	Int32	Use instead of: autoTitleHeadingLevel		Optional	If auto-titling the graph, the heading level to use.	From 1 to 6	N/A
type	GraphType	Use instead of: graphType		Optional	The graph type. Defaults to Device. Options are: Device, WebsiteOverview, NetflowBandwidth, WebsiteCheckPoint and DashboardWidget.	Device WebsiteOverview NetflowBandwidth WebsiteCheckPoint DashboardWidget	Device
useCache	Boolean			Optional	Whether to use the cache (where supported).	true false	false
waitDuringUpgrades	Boolean			Optional	Whether to wait during LogicMonitor upgrades (i.e. execution essentially pauses).	true false	N/A
warning	String			Optional	If specified, adds a warning message for this macro. This is processed as an NCalc, and the warning message will ALWAYS be present and will be the value of the evaluated NCalc expression.	N/A	N/A
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
websiteId	List<Int32>	Deprecated	websiteIds		The website ID or IDs.	N/A	N/A
websiteIds	List<Int32>	Use instead of: websiteId		Optional	The website ID or IDs.	N/A	N/A
writeToSpreadsheet	Boolean			Optional	Whether to write output to a spreadsheet.	true false	N/A

Examples (2)

Example 1:

[LogicMonitor.InstanceGroupList: device=pdl-fw-01, dataSourceName=snmp64_If-]

Example 2:

Obtain the list for multiple Device IDs: