General SWQL guidelines for SolarWinds Platform products
This topic applies to all SolarWinds Platform (self-hosted) products.
The following guidelines apply specifically to the use of SWQL in SolarWinds Platform products.
Fields that are used in multiple database tables, such as Caption or Status, must be preceded by the specific table. For example, use NodesData.Caption to display captions on nodes
Wildcards
The wildcard character in SWQL syntax is: %.
Example: NodesData.Caption Like 'AX3%'
Filtering by custom property
The property syntax to filter by custom property is:
dataType.CustomProperties.propertyName
Example filter to only show nodes with the custom property City that matches Atlanta:
Node.CustomProperties.City = 'Atlanta'
Filtering by built-in properties
Many properties have the same name between data types. To prevent ambiguity, the data type is a included as a prefix to the property names.
Examples
Example filter to show data from Cisco devices:
Node.Vendor = 'Cisco'
Example filter to show data from Windows Server 2003-2008 applications:
Application.Name = 'Windows Server 2003-2008'
Example filter to show data from devices beginning with "AX3":
Node.Caption Like 'AX3%'
Example filter to show data from Process Monitor – SNMP type component monitors:
Monitor.ComponentType = 8
Filtering by status
To filter by the status property, you must know the valid status levels.
Level |
Status |
---|---|
0 |
Unknown |
1 |
Up |
2 |
Down |
3 |
Warning |
14 |
Critical |
Example filter to only show monitors that are not down:
MonitorStatus.Availability<>2
Built-in SWQL nodes properties
Node.AvgResponseTime |
Node.CPULoad |
Node.Caption |
Node.Contact |
Node.DNS |
Node.Description |
Node.GroupStatus |
Node.IOSImage |
Node.IOSVersion |
Node.IPAddress |
Node.LastBoot |
Node.LastSync |
Node.Location |
Node.MachineType |
Node.MaxResponseTime |
Node.MemoryUsed |
Node.MinResponseTime |
Node.NodeID |
Node.ObjectSubType |
Node.OrionID |
Node.PercentLoss |
Node.PercentMemoryUsed |
Node.ResponseTime |
Node.Severity |
Node.Status |
Node.StatusDescription |
Node.SysName |
Node.SysObjectID |
Node.SystemUpTime |
Node.TotalMemory |
Node.Vendor |
Node.VendorIcon |
Node.ID |