Marvis Query Languages (MQL) User Guide
Version 1.0
Juniper Networks
Introduction
This manual explains the Marvis Query Languages (MQL) user guide. The content is based on Mist Cloud as of May 2025. Actual screens and displays may differ; please refer to the update information below for any discrepancies.
https://www.juniper.net/documentation/us/en/software/mist/product-updates/
Configuration details and parameters vary depending on the environment and configuration. For detailed configuration information, please check the link below.
https://www.juniper.net/documentation/product/us/en/mist/
Many other Mist Japanese manuals are also available on the "Solutions & Technical Information Site".
https://www.juniper.net/jp/ja/local/solution-technical-information/mist.html
The content of this document is as of the time of creation and is subject to change without prior notice. The configurations and functions described in this document cannot be provided as a condition of purchase.
Update History
Version | Update Date | Summary |
---|---|---|
Ver 1.0 | May 2025 | Initial Release |
Marvis Query Languages Overview
Marvis Query Languages (MQL) is a structured framework for querying Marvis to obtain data useful for network monitoring and troubleshooting. By executing queries, you can quickly obtain detailed information about network events, failures, and affected devices.
The query structure involves:
- Query Type: Specifies the type of data to retrieve (e.g., LIST, ATTRIBUTE, COUNT).
- Query Object: The target of the query (e.g., Clients, Access Points, Sites).
- Clause (WITH, BY, etc.): Filters or conditions for the query.
- DURING: Specifies the time period for the query.
- Value: Specific identifiers like client names or device names.
Queries are constructed by combining these elements to form a request to Marvis.
MQL Execution Steps
To start using MQL, navigate to [Marvis], then click on [Marvis Actions], and finally click on [Ask a Question].
1. Entering a Query:
Move the cursor to the query input field. Initially, you will specify the query type. As you type, possible items will be displayed, and you can select from them. Direct input is also possible, which will narrow down the selection options as you type.
There are 10 types of queries. For an overview, see the Query Types list.
2. Completing the Query:
After selecting the query type, press space to see the next set of options. Continue selecting (or typing) and pressing space to build the query syntax. For example: ROAMINGOF_{AP Name} DURING "TODAY"
You can specify the time range using the DURING clause.
Press Enter to execute the query. The results will be displayed. You can modify parameters by clicking on the gray areas in the results display.
A reset button is available for the results display.
Query Types Overview
ATTRIBUTE [Attribute] OF [Target Device]
Displays attribute information of target devices.
Example: ATTRIBUTE Clients OF "LD_Kitchen"
COUNT [Target] (WITH...DURING...)
Displays the count of the target items.
Example: COUNT Clients WITH Site "Live-Demo" DURING "Today"
LIST [Target] (WITH...DURING...)
Lists the target items.
Example: LIST SwitchEvents WITH Site "Live-Demo" AND SwitchEventType Port-Down
LOCATE [Target]
Confirms the location of the target. MAP/Site/FloorPlan.
Example: LOCATE "LD_Kitchen"
RANK [Target] BY [Sort Target] (WITH...DURING...)
Sorts the target items in order of the sort target.
Example: RANK Sites BY ClientCount WITH WLAN Guest DURING "Last 7 Days"
ROAMINGOF [Client] (DURING...)
Checks the roaming status of the client.
Example: ROAMINGOF "Alejandro"
SEARCH [Target]
Searches for target items (devices/pages on Cloud/documents, etc.).
Example: SEARCH NAC
STATUSOF Clients (WITH...DURING...)
Performs correlation analysis of problems.
Example: STATUSOF Clients WITH Site "Live-Demo" AND Problem Coverage
TROUBLESHOOT [Troubleshoot Target] (WITH...DURING...)
Displays the status of the troubleshoot target and performs root cause analysis.
Example: TROUBLESHOOT "aconcagua" DURING "Yesterday"
UTILIZATIONOF [Target AP] (DURING...)
Displays the channel utilization of the target AP.
Example: UTILIZATIONOF "LD_JSW" DURING "This Week"
Thank You
Thank you for using Marvis Query Languages.