> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.itential.com/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.itential.com/_mcp/server.

# Navigate the main canvas UI

> A visual walk-through of navigating the main canvas, property details, and API documentation in Itential Gateway.

## Navigate the UI

This page provides a visual walk-through of how to navigate the main canvas in Itential Gateway, including the interface for version information, API documentation, and sign out.

![](/_fern-img/f267554e857642348e6fa5317885373241e1468f65d71c0dc5b9d7982197723b.webp)

| UI Label | Description                                                                                                                                                                                                                                                                                 |
| -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| 1        | The left navigation tree view provides a group list of all the modules, roles, playbooks, and devices in your Ansible deployment.                                                                                                                                                           |
| 2        | The top toolbar displays the group name (i.e. family) and unit within that collection. A breadcrumb trail allows you to keep track of your location within Itential Gateway.                                                                                                                |
| 3        | The main canvas is a card-based user interface. It captures each input within a family and provides a brief description.                                                                                                                                                                    |
| 4        | The **Details** icon for each card opens a screen to display a list of configurable parameters and values. Information displayed on the Details screen aligns with information shown in the [Red Hat Ansible documentation](https://docs.ansible.com/ansible/latest/user_guide/index.html). |
| 5        | You can "decorate" (enhance) a configuration by augmenting the variables of a module, role, or playbook. A **blue** triangle denotes user-applied decoration. An **orange** triangle denotes Itential-applied decoration. Decoration is stored in the database.                             |

![](/_fern-img/9c45e89b00963a6fa7222fb800030ee01e4edd7b2662db2f039bb0e29fe2ff58.webp)

| UI Label | Description                                                                                                                       |
| -------- | --------------------------------------------------------------------------------------------------------------------------------- |
| 1        | Click the menu icon to open a separate dialog box.                                                                                |
| 2        | Click **About** to display the version of Itential Gateway and Ansible that is running.                                           |
| 3        | Click **Documentation** to open a slide-out panel from the right. The panel provides access to the API documentation for Gateway. |
| 4        | Click **Sign Out** to exit Itential Gateway. You will return to the login screen.                                                 |

## Display the property details

This guide provides a brief walk-through of how to access property details in Itential Gateway.

![](/_fern-img/0d2da4aa902cb7e0e70572233ddd9aecd7691d553e597f83f9860d105edbfada.webp)

| UI Label | Description                                                                                                                                                                                                                                                                                       |
| -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| 1        | Click the **Information** icon to display the name and schema type for your Ansible deployment of a module, role, or playbook. For devices, the OS type and device user role is displayed. This information is rendered directly from the Red Hat Ansible® documentation.                         |
| 2        | Click the **Edit** icon to display the JSON schema in edit mode.                                                                                                                                                                                                                                  |
| 3        | Use the **Revert** icon to roll back any changes made to the JSON properties for a module, role, playbook, or device. This resets the schema to the original property settings shipped with the current installation. To the right of **Revert** are icon buttons to import/export a JSON schema. |
| 4        | Use the top row of fields to search and sort by various parameters (i.e., name, type, description, etc.).                                                                                                                                                                                         |

> **Info**
>
> Import and export icons are not displayed on the Parameters tab in the 2022.1 release.
>
> ![](/_fern-img/b1c0b8a11188992cfe60f178234d8c5df6ff197fafe83bcc692a1d0ca4d7497f.webp)

## Access the API documentation

When you click **Documentation** in the dialog menu, a slide-out panel opens from the right. The panel provides access to the API documentation for Itential Gateway.

![](/_fern-img/093144033452dadd93e7b2b7269e43be41a9182a1976adebae1720390dafff1e.webp)

| UI Label | Description                                                                                                               |
| -------- | ------------------------------------------------------------------------------------------------------------------------- |
| 1        | The click-out panel for **API Documentation** can be used to pop out the window. The floating window can then be resized. |
| 2        | The **Try it out** button allows you to interact with and run each operation command the API exposes in Itential Gateway. |
| 3        | Click **Close** at the bottom to close the panel.                                                                         |