Mason Docs

Setting up X-Ray



For setting up X-Ray on devices running Mason OS version 6.0.5 and lower see this guide

  1. Download the latest Mason CLI+

    Support for the latest X-Ray was first introduced in Mason CLI v2.0. Check out the latest release at the Mason CLI release page.

  2. Download Mason OS 6.0.6+

    The latest version of X-Ray is available on Mason devices running Mason OS 6.0.6+.

    To check the Mason OS version your device is running. Log in to your Mason Controller account and navigate to your device's details page by clicking on the serial number. Then click the Software tab and under the OS section verify the Mason OS Version is 6.0.6 or higher.

    If your device is not running Mason OS 6.0.6+, then use the Mason Controller to deploy a mason-os update to your device. You can do this by navigating to your group's detail view in Controller and selecting Mason OS update from the 'Deploy to group' drop down in the upper right.

  3. For using X-Ray on the CLI, create a Mason API with XRAY:ADMIN scope

    X-Ray requires a XRAY:ADMIN scoped Mason API key in order to authenticate the user attempting to connect to the device. Check out the guide on "How to create an API key". Once an API key is created, you will need to pass the API key along with the Mason xray commands.

  4. Using X-Ray with your device in Controller

    In order to use X-Ray in the Controller, the device will need to have a stable WiFi or cellular connection. To check if your device is properly communicating to the Mason Platform. Navigate to the device's details page in your Controller account, click the Info tab and verify the device's Connection status is Online.

    To use desktop mode (vnc) with your device to view the device's screen and interact with and control the device remotely, navigate to the Remote Control tab on the device's details page in your Controller account.

    To view and filter your device's logs, navigate to the Logs tab on the device's details page in your Controller account.

    If the device's connection status is Offline. Hover, over the Offline status to see the list of possible reasons and visit our X-Ray FAQ page.


Next Steps