For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Open sourceSupportFAQsDocs Home
DocumentationCommand referenceRelease notes
DocumentationCommand referenceRelease notes
  • Itential Automation Gateway
    • Overview
    • Execution engine
    • Concepts
    • Feature comparison
    • IAG secret store
      • Create a service
      • View service details
      • Python virtual environments
      • Configure dependency registries
      • Validate service inputs with decorators
      • Inject secrets into services
      • Add services to workflows
    • Inventory Manager
LogoLogo
Open sourceSupportFAQsDocs Home
On this page
  • View service details using the CLI
  • View service details in Gateway Manager
Itential Automation GatewayGateway services

View service details

Was this page helpful?
Previous

Python virtual environments

Next
Built with

After you create a gateway service, you can view its details to verify the configuration or check service properties. You can view service details using the iagctl CLI or the Platform UI in Gateway Manager.

View service details using the CLI

Run the iagctl describe service command to display all details about a specific gateway service.

$iagctl describe service <name>

Replace <name> with the name of the service you want to view.

The output varies depending on the service type. Select a tab to see example output for each automation type.

Ansible playbook
Python script
OpenTofu plan
$iagctl describe service simple-ansible
Output:
Name: simple-ansible
Repo Name: gateway-resources
Working Dir: ansibleplaybooks
Playbook(s): hello-world.yml
Decorator:
Description:
Tags:
Runtime Arguments:

For the full command reference, see iagctl describe service.

View service details in Gateway Manager

To view service details in the Platform UI:

  1. Navigate to Itential Platform.
  2. Select Gateway Manager from the Administration collection in the left-side navigation menu.
  3. Navigate to the Gateways tab in Gateway Manager.
  4. Select the gateway cluster that you want to view from the list of gateways.
  5. Open the Services tab on the gateway details page.

The Services tab displays the Service Name, Type (ansible-playbook, python-script, or opentofu-plan), and indicates whether there are Decorators associated with the service.

Select a service from the list to expand and view the service details. The expanded view displays when the service was Last Executed, lists which workflows reference the service, and displays the service parameters.