Get all applications configured on the Itential Platform instance.

Restart an application on Itential Platform.

Behavior based on current application state:

• RUNNING: Attempts to restart and waits for RUNNING state

• STOPPED/DEAD/DELETED: Raises InvalidStateError (cannot restart)

Start an application on Itential Platform.

Behavior based on current application state:

• RUNNING: No action taken (already started)

• STOPPED: Attempts to start and waits for RUNNING state

• DEAD/DELETED: Raises InvalidStateError (cannot start)

Stop an application on Itential Platform.

Behavior based on current application state:

• RUNNING: Attempts to stop and waits for STOPPED state

• STOPPED: No action taken (already stopped)

• DEAD/DELETED: Raises InvalidStateError (cannot stop)

Get aggregate job metrics from the Workflow Engine.

The Workflow Engine maintains comprehensive metrics about workflow execution performance, providing insights into automation efficiency, success rates, and resource utilization across all workflow jobs.

Get the job metrics for the specified workflow from Workflow Engine.

Retrieves job execution metrics filtered by a specific workflow name, providing targeted insights into the performance and execution statistics for jobs within that particular workflow.

Get all aggregate task metrics from the Workflow Engine.

Retrieves comprehensive task-level execution metrics across all workflows, providing detailed insights into task performance, application usage patterns, and execution statistics for automation monitoring and optimization.

Get all task metrics for the specified application from Workflow Engine.

Retrieves task execution metrics filtered by a specific application name, providing insights into how tasks performed by that application are executing across different workflows and automation processes.

Get all task metrics for the named task from Workflow Engine.

Retrieves task execution metrics filtered by a specific task name, providing detailed performance insights for that particular task across all workflows where it appears.

Get all task metrics for the specified workflow from Workflow Engine.

Retrieves task execution metrics filtered by a specific workflow name, providing detailed insights into the performance of individual tasks within that particular workflow for targeted analysis and optimization.

Add one or more devices to a device group

This tool will add one or more devices to a named device group defined in Itential Platform. The name argument specifies the name of the device group to add the list of devices to. The name must be a valid device group. The list of named device groups can be found using the get_device_groups tool.

The devices argument provides the list of devices to be added to the named device group. This operation is additive and idempotent: it merges the supplied devices into the group's existing device list rather than replacing it, and devices already present in the group are not duplicated. Passing an empty list or None is a no-op that leaves the group's devices unchanged.

Create a new device group on Itential Platform.

Device groups enable logical organization of network devices for streamlined management, configuration deployment, and automation workflows.

Get all device groups from Itential Platform.

Device groups are logical collections of network devices that can be managed together for configuration, compliance, and automation tasks. They provide an organizational structure for grouping devices by function, location, or type.

Remove one or more devices from a device group

This tool will remove one or more devices from a named device group. The name argument specifies the name of the device group to remove the list of devices from. The name must be a valid device group. The list of device groups can be found using the get_device_groups tool.

The devices argument provides the list of devices to be removed from the device group.

Create a new integration model on Itential Platform from an OpenAPI specification.

Integration models enable Itential Platform to interact with external systems by defining their API structure and capabilities. The model must be a valid OpenAPI specification document.

Get all integration models from Itential Platform.

Integration models define API specifications for external systems and services that can be integrated with Itential Platform. They are based on OpenAPI specifications and enable automated interaction with third-party systems.

Get all integration instances from Itential Platform with optional model filtering.

This function retrieves integration instances from the Itential Platform. Integration instances are configured implementations of integration models that define connections to external systems.

Get all compliance plans from Itential Platform.

Compliance plans define configuration validation rules and checks that can be executed against network devices to ensure they meet organizational standards.

Execute a compliance plan against network devices.

Compliance plans validate device configurations against organizational standards by running predefined checks and rules. This function starts a compliance plan execution and returns the running instance details.

Get detailed information about a specific agent session.

Returns the full session record including all event messages emitted during agent execution and the final text output produced by the agent.

List agent sessions from Itential Platform.

Agent sessions are created when an agent automation is triggered via an endpoint trigger. Each session records the agent that ran, its execution status, and timing information.

Create a new Lifecycle Manager resource model on Itential Platform.

Resource models define the structure, validation rules, and lifecycle workflows for network services and infrastructure components. They serve as templates for creating and managing resource instances.

Get details about an instance of a Lifecycle Manager resource

Gets the resource instance that is specified in the instance_name argument and returns the instance details. This function will return an error if the instance does not exist

Get detailed information about a Lifecycle Manager resource model.

Get action execution history from Lifecycle Manager filtered by resource and instance.

Retrieves the history of action executions performed in the Lifecycle Manager, including details about action runs, their status, timestamps, and associated resources and instances.

Get all instances of a Lifecycle Manager resource from Itential Platform.

Resource instances represent actual network services or infrastructure components created from resource models. They contain the specific data and state information for managed resources.

Get all Lifecycle Manager resource models from Itential Platform.

Lifecycle Manager resources define data models and workflows for managing network services and infrastructure components throughout their lifecycle. They provide structured templates for creating and managing resource instances.

Run an action that is associated with a Lifecycle Manager resource

Add a new node to an existing Golden Configuration tree.

Nodes in Golden Configuration trees represent configuration sections or components that can be organized hierarchically. Each node can have an associated configuration template and belongs to a specific version of the tree structure.

Create a new Golden Configuration tree on Itential Platform.

Golden Configuration trees define hierarchical configuration templates for network devices. They support variable substitution and version management to provide consistent, reusable configuration structures across device types.

Get all Golden Configuration trees from Itential Platform.

Golden Configuration trees are hierarchical templates that define configuration structures for network devices. They provide a framework for managing device configurations with variable substitution and version control capabilities.

Create a new template in Automation Studio.

Creates a new template with the specified name, type, group, and optional content including command, template text, and sample data. Templates are used for text processing, configuration generation, and data parsing within automation workflows.

Get detailed information about a specific template from Automation Studio.

Retrieves comprehensive template information including name, description, type, group, command, template content, and sample data. Templates are used for text processing, configuration generation, and data parsing within automation workflows.

Get all templates from Automation Studio.

Retrieves all templates from the Automation Studio, with optional filtering by template type. Templates are used for text processing, configuration generation, and data parsing within automation workflows.

This function performs paginated requests through the automation studio service to retrieve all available templates, handling large result sets efficiently. Results are transformed into standardized GetTemplatesElement objects for consistent API responses.

Update an existing template in Automation Studio.

Updates an existing template with new content including command, template text, and sample data. Only specified fields will be updated; fields not provided will retain their existing values. Templates are used for text processing, configuration generation, and data parsing within automation workflows.

Get comprehensive health information from Itential Platform.

System health monitoring provides visibility into platform performance, resource utilization, and component status. This enables proactive monitoring and troubleshooting of the automation infrastructure.

This function uses parallel async API calls to efficiently retrieve health data from all platform endpoints simultaneously, providing optimal performance for comprehensive health monitoring.

Note: This function also provides a complete list of all applications and adapters running on the platform as part of the health data.

Get all adapters configured on the Itential Platform instance.

Restart an adapter on Itential Platform.

Behavior based on current adapter state:

• RUNNING: Attempts to restart and waits for RUNNING state

• STOPPED/DEAD/DELETED: Raises InvalidStateError (cannot restart)

Start an adapter on Itential Platform.

Behavior based on current adapter state:

• RUNNING: No action taken (already started)

• STOPPED: Attempts to start and waits for RUNNING state

• DEAD/DELETED: Raises InvalidStateError (cannot start)

Stop an adapter on Itential Platform.

Behavior based on current adapter state:

• RUNNING: Attempts to stop and waits for STOPPED state

• STOPPED: No action taken (already stopped)

• DEAD/DELETED: Raises InvalidStateError (cannot stop)

Get detailed information about a specific Automation Studio project.

Retrieves comprehensive project information including all components (workflows, templates, and other artifacts) contained within the project along with their metadata and organization structure.

Get all Automation Studio projects from Itential Platform.

Projects in Automation Studio organize workflows, templates, and other automation artifacts into logical groupings for team collaboration and asset management.

Retrieve detailed compliance report results from Itential Platform.

Compliance reports contain the results of executing compliance plans against network devices, showing configuration validation outcomes, rule violations, and compliance status for each checked device.

Get detailed information about a specific job from Itential Platform.

Jobs are created automatically when workflows are executed and contain comprehensive information about the workflow execution including status, tasks, metrics, and results.

Expose an agent as an API endpoint trigger.

Creates an automation wrapping the specified agent and an endpoint trigger so the agent can be started via trigger_automation using the assigned route_name.

Expose a workflow as an API endpoint.

Creates an automation and API endpoint trigger to expose a workflow for external consumption. This enables workflows to be called via REST API endpoints with custom routing and input validation.

Get all agent automations from Itential Platform.

Agents are AI-driven automation components managed by the Operations Manager. Each agent automation may optionally have an endpoint trigger that exposes it for programmatic invocation via the same mechanism as workflows.

Get all automations from the Itential Platform Operations Manager.

Returns a unified list of all automation objects regardless of component type (workflows, agents, compliance plans). Each entry includes the component_type discriminator and the route_name needed to trigger it via trigger_automation.

Use this when you need a full picture of what is available in the Operations Manager. Use get_workflows when you only need workflow-type automations.

Get all jobs from Itential Platform.

Jobs represent workflow execution instances that track the status, progress, and results of automated tasks. They provide visibility into workflow execution and enable monitoring of automation operations.

Get all workflow API endpoints from Itential Platform.

Workflows are the core automation engine of Itential Platform, defining executable processes that orchestrate network operations, device management, and service provisioning. Each workflow exposes an API endpoint that can be triggered by external systems or other platform components.

Triggers a workflow automation endpoint by route name.

This is a thin wrapper around trigger_automation, kept as a stable, workflow-specific entry point. trigger_automation is the general-purpose tool and also supports non-workflow automation types (e.g. agents).

Trigger an automation via its Operations Manager endpoint.

Executes any automation (workflow or agent) by calling its endpoint trigger. The response type depends on the automation's component type:

• Workflow automations return a job object (StartWorkflowResponse) monitored via describe_job.

• Agent automations return a session object (StartAgentResponse) monitored via describe_session.

Use get_automations to discover available automations and their component_type before triggering, so you know which monitoring tool to use afterward.

Add nodes in bulk to an existing inventory on Itential Platform.

Adds one or more nodes with full attribute details to an inventory. Each node requires a name and attributes dictionary containing connection and platform details. Tags can be optionally provided per node for classification.

Create a new inventory and optionally populate it with devices on Itential Platform.

Inventories enable logical organization of network devices for streamlined management, configuration deployment, compliance checking, and automation workflows. Devices can be added during creation or later.

Delete an inventory from Itential Platform.

Permanently removes an inventory and all its device associations. The devices themselves are not affected; only the inventory grouping is deleted. This operation cannot be undone.

Get detailed information about a specific inventory from Itential Platform.

Retrieves comprehensive details about an inventory including its description, groups, actions, tags, and the list of nodes (devices) with their attributes. The inventory is identified by its name.

Get all inventories from Itential Platform.

Inventories are collections of network devices organized for bulk configuration management, compliance checking, and automation tasks. They provide an organizational structure for grouping devices by function, location, or type.

Get the list of all know services from Itential Platform Gateway Manager

Get the list of all know services from Itential Platform Gateway Manager

Run an existing service using the optional input parameters

Apply configuration commands to a network device through Itential Platform.

Configuration deployment enables automated provisioning and updates of network device settings, supporting configuration management and infrastructure automation.

Create a backup of a device configuration in Itential Platform.

Configuration backups provide recovery points and change tracking for network devices, enabling rollback capabilities and configuration management workflows.

Retrieve the current configuration from a network device.

Get all devices known to Itential Platform.

Itential Platform federates device information from multiple sources and makes it available for network automation workflows. Devices represent physical or virtual network infrastructure that can be managed, configured, and monitored.

Create a new command template in Itential Platform.

Creates a new command template with the specified name, commands, and validation rules. Templates can be created in the global space or within a specific project.

Get detailed information about a specific command template.

Get all command templates from Itential Platform.

Command Templates are run-time templates that actively pass commands to devices and evaluate responses against defined rules. Retrieves templates from both global space and projects.

Run a single command against multiple devices.

Execute a command template against specified devices with rule evaluation.

Command Templates are run-time templates that actively pass commands to a list of specified devices during their runtime. After all responses are collected, the output set is evaluated against a set of defined rules. These executed templates are typically used as Pre and Post steps, which are usually separated by a procedure (router upgrade, service migration, etc.).

Update an existing command template in Itential Platform.

Updates an existing command template with new commands and validation rules. The template must exist in the specified project or global space.

Render a Jinja2 template with provided variables.

Jinja2 templates are commonly used in network automation for generating device configurations, commands, and other text-based content by combining template structures with dynamic variable values.