- 03 Nov 2024
-
DarkLight
-
PDF
Using the Automation Service
- Updated on 03 Nov 2024
-
DarkLight
-
PDF
If your organization has licensed and set up the Itential Automation Service, your first step is to log in to your Itential Cloud account using your organization ID and your personal access credentials.
If you're not sure what your organization ID or personal access credentials are, check with your manager or Itential account administrator.
Verify You Are Licensed to Use the Automation Service
Once you have logged in, you should see a menu in the portal sidebar with the heading Automation and these options:
- Operations
- Automations
- Activities
- Gateways
If you do not see these menu items, then your organization is not licensed to use the service and you should contact your Itential account administrator.
Verify Connected Gateway & Available Automations
For new users (operators) to the Itential Cloud Service service, a good place to start is to see what automations are available.
- This part of the guide assumes that an administrator has already set things up so that IAG5 can connect to this service, and it also assumes the operator is part of a group that has access to at least one connected gateway.
To check if there is at least one gateway connected:
-
Login to your Itential Cloud account using your organization ID.
- If you are not able to log into Itential Cloud then you are not authorized to access the service. You should check with your administrator about getting access.
-
From the left-side navigation menu, go to
Automation
→Gateways
to confirm there is at least one gateway that displays.-
If you do not see Automation in the navigation menu, then your organization is not licensed to use the Itential Cloud Service service. We encourage you to speak with your administrator about when this service will be made available.
-
If you can access the Gateways workspace from the navigation menu, but no gateways are listed, then your administrator has not configured one to connect or you do not have access to any gateways that may exist. If you think a configured gateway should be listed, check with your administrator about being added to the gateway’s groups.
-
-
Next, navigate to
Automation
→Automations
.- This step will take you to the Automations workspace which lists all of the automations that were discovered from all of the connected gateways (Figure 2). If the user has access to a gateway, then the user also will have access to all automations from the gateway.
Figure 1
Add IAG5 Services to Itential Cloud Service
Getting IAG5 connected to your AGS instance takes only a few steps; however, some information will need to be shared with the owners of IAG5 as well as collected from them.
⚠ Warning: Itential Cloud Service only supports Itential Automation Gateway 5.x. It is not compatible with older product versions of the Itential Automation Gateway such as v4.3, or v2023.3 or older.
You can connect to as many IAG5 services as needed as long as enough licenses are available.
Provide Gateway Connection URL
Each IAG5 must be configured with a connection URL/port number.
- From the left-navigation menu, go to
Automation
→Gateways
- Locate the Gateway Connection URL field. Click the copy icon to copy the URL.
- Send the URL to the IAG5 owners. The information in the URL is not considered sensitive.
Collect Cluster ID and Public Certificates
To allow IAG5 to connect to your Itential Cloud Service account, the following is needed from the IAG5 owners:
- The Cluster ID of the IAG5 service cluster.
- The Certificates for each of the IAG5 controller nodes in the IAG5 cluster.
ⓘ Note: If the IAG5 service owners are using a public wildcard certificate for their controller nodes, then expect them to provide just one certificate. You can add/remove certificates for a gateway at any time after it has been created whenever controller nodes are added or removed.
Upload Certificates
Once the user has the required certificate information, add the certificate information to the gateway:
-
Select
Gateways
from the left-navigation menu. -
Click Upload Certificate at the top of the Gateways workspace.
-
From the UI, you can drag and drop your files into the drag-and-drop area to upload your
certificate
files. Alternately, select theclick to browse
link to navigate to the files on your system. -
You will be given the option to verify the certificate is correct. Once you have verified it, click Save Certificate.
-
Repeat Steps 2 through 4 until you have loaded all the certificates needed.
Add a New Gateway
Next, add a new gateway:
-
Click Add Gateway at the top of the Gateways workspace to open the configuration dialog.
-
Give the new gateway a unique name (required).
-
Enter an optional description for the gateway.
-
Enter the unique Cluster ID that was provided (required).
-
From the dropdown, automatically enable (or disable) the gateway for connection (required).
-
Click Next to proceed. You will be asked to select the certificates associated with the gateway.
-
Select all the certificates that were uploaded, or select No, I’ll do it later.
Add Gateway Groups and Permissions
The final step is to set the gateway groups and permissions:
-
Select the checkbox for which groups will have access to the gateway. One Group Name must be selected.
- If there is a person icon under the Member column, that means the user is a member of that Group.
-
Click Create to finalize the gateway configuration and group permissions.
View the Gateway Status
Once the gateway is added, navigate back to the Gateways Workspace where the status of all gateways that have been added/connected can be viewed.
Figure 2
The status of some gateways are influenced by the administrator while other statuses are influenced by the IAG5 service itself.
Status | Explanation | # Licenses Used |
---|---|---|
Enabled | The gateway is enabled in Itential Cloud Service, and is also currently connected. It uses one license. | 1 |
Disabled | The gateway has been disabled in Itential Cloud Service, and will not be permitted to connect. It does not use any licenses. | 0 |
Error | The gateway is enabled in Itential Cloud Service, but there is a problem with the gateway connection to Itential Cloud Service. | 0 |
Read-Only | The gateway is enabled in Itential Cloud Service, and is also currently connected, but the gateway cannot be asked to run new automations, and scheduled automations are not allowed to run. | 1 |