- 18 Oct 2024
-
DarkLight
-
PDF
Managing Instances
- Updated on 18 Oct 2024
-
DarkLight
-
PDF
The homepage of Itential Cloud Portal, Instances, provides a unified interface for managing your cloud-based Itential Automation Platform (IAP) instances. To access the Instances page, select Instances from the sidebar of Itential Cloud Portal:
Figure 1: Instances Page in the Sidebar
Instances Table
The UI of the Instances page is largely composed of the Instances table, which provides a searchable and sortable view of your organization's cloud-based IAP instances. Its main elements are referenced in Figure 2.
Label | UI Element | Function |
---|---|---|
1 | Refresh Button | Refreshes the table. |
2 | Search Bar | Used to search and filter instances by Name, Id, or Env. |
3 | Table Body | Displays instances matching any specified search filters. |
4 | Pagination Controls | Sets how many table rows to show per page and shows the total number of discrete pages. Use the left and right arrows to move between pages. |
Figure 2: Instances Table
Fields in the Instances Table
Each row in the Instances table corresponds to an instance of IAP, while each column provides information about that instance or user actions that can be taken against that instance. Each table column, or field, is referenced below.
Table Field | Description |
---|---|
Status | The current status of the instance. Valid states are Online (✔), Offline (X), and Initializing (!). |
Name | The name of the instance. Click the instance name to modify the instance. |
Id | The automatically generated identity of the instance. Click the Id number to modify the instance. |
Launch | Click the icon button to launch the UI of the instance in a new web browser tab. |
Env | The environment (Env) assigned to the instance at instance creation. |
Tag | The IAP version of the instance. |
Type | The classification of the instance. Currently, a standard type is assigned when a new instance is created. |
Uptime | The amount of time the instance has been online. |
Cluster | The high availability cluster the instance is running in. |
Created | The date and time the instance was created. |
Expiration | The date and time at which the instance will expire. |
Launching an Instance
To launch an instance from the Instances page:
- Locate the desired instance in the Instances table.
- If you know the name or Id of the instance, or the environment the instance is assigned to, you can apply it as a filter using the Search Bar.
- You can sort the Instances table by any field (excluding Launch) in ascending or descending order by selecting the relevant column header.
- Click the Launch icon from the Launch field of the desired instance; the UI of the instance will open in a new web browser tab.
Restarting an Instance
To restart an instance from the Instances page:
- Locate the desired instance in the Instances table.
- If you know the name or Id of the instance, or the environment that the instance is assigned to, you can apply it as a filter using the Search Bar.
- You can sort the Instances table by any field (excluding Launch) in ascending or descending order by selecting the relevant column header.
- Click the Name or Id of the instance. The Modify Instance window will open.
- From the Modify Instance window, click the Restart icon; a confirmation modal will appear.
- Click the Restart button at the bottom-left corner of the modal. A success bannner will display when the restart process has been successfully initiated.
Figure 3: Modify Instance