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
      • Overview
      • Create an executable object
      • Manage executable objects
      • Use executable objects with services
        • Overview
        • Create an executable service
        • Run an executable service
        • Manage executable services
    • Inventory Manager
LogoLogo
Open sourceSupportFAQsDocs Home
On this page
  • Run an executable service
  • Run an executable service with arguments
Itential Automation GatewayExecutable objects and servicesExecutable services

Run an executable service

Was this page helpful?
Previous

Manage executable services

Next
Built with

After you create an executable service, you can run it to execute your script or application. You can also pass runtime arguments to customize each execution.

Run an executable service

Use the iagctl run service executable command to execute an executable service.

Syntax:

$iagctl run service executable <service-name>

Example:

$iagctl run service executable simple-executable

This command executes the service using the configuration you defined when you created it.

Run an executable service with arguments

You can pass runtime arguments to your script when you run the service. IAG formats these arguments according to the --arg-format you specified when you created the service.

Syntax:

$iagctl run service executable <service-name> \
> --set key1=value1 \
> --set key2=value2

Example:

$iagctl run service executable simple-executable \
> --set environment=production \
> --set region=us-east

If you configured the service with --arg-format "{{.Key}} {{.Value}}", IAG passes these arguments to your script as:

environment production region us-east

If you configured the service with --arg-format "{{.Key}}={{.Value}}", IAG passes these arguments to your script as:

environment=production region=us-east