Instances

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. The Instances Table provides a searchable and sortable view of your organization's cloud-based IAP instances, from which you can:

• Create or delete instances.
• Launch or restart instances.
• Modify instances.

The main elements of the Instances Table are referenced in Figure 2.

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.

Creating an Instance

To create an instance from the Instances page:

1. Click the Create a new IAP instance (+) icon from the Instances Table toolbar; the Create an Instance of IAP modal appears.
2. Select an environment (a logical grouping of IAP instances) to assign the new IAP instance to from the Environment drop-down menu.
3. Enter a name for the IAP instance in the Name field.
4. Click the Create button at the bottom-left corner of the modal.

Immediately after being created, the new instance will display a status of Initializing (!). When the instance is ready to be launched, its status will change to Online (✔).

Launching an Instance

To launch an instance from the Instances page:

1. 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.
2. 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.

Modifying an Instance

Some properties of existing instances can be modified through the Modify Instance window. From this window, you can:

• Launch the instance.
• Restart the instance.
• Delete the instance.

To access the Modify Instance window:

1. 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.
2. Click the Name or Id field of the desired instance to open the Modify Instance window.

The main elements of the Modify Instance window are referenced in Figure 3.

Figure 3: Modify Instance

Restarting an Instance

To restart an instance from the Modify Instance window:

1. Click the Restart icon from the toolbar; a confirmation modal will appear.
2. Click the Restart button at the bottom-left corner of the modal. A success bannner displays when the restart process has been successfully initiated for the instance.

Deleting an Instance

To delete an instance from the Modify Instance window:

1. Click the Delete icon from the toolbar; a confirmation modal will appear.
2. Enter the the text indicated by the modal into the entry field.
3. Click the Delete Instance button at the bottom-left corner of the modal.