ansible CLI reference

ModularPipelines.Ansible provides strongly typed access to the ansible CLI.

Installation

dotnet add package ModularPipelines.Ansible

Resolve the service with context.Tools.Ansible. For projects older than C# 14, import ModularPipelines.Ansible.Extensions and use the context.Ansible() extension method as a compatibility fallback.

Module example

using ModularPipelines.Context;
using ModularPipelines.Models;
using ModularPipelines.Modules;
using ModularPipelines.Ansible.Options;

public class RunCommandModule : Module<CommandResult>
{
    protected override async Task<CommandResult> ExecuteAsync(
        IModuleContext context,
        CancellationToken cancellationToken)
    {
        return await context.Tools.Ansible.ExecuteAsync(
            new AnsibleExecuteOptions("value"),
            cancellationToken: cancellationToken);
    }
}

Commands

CLI command	Options record
ansible	AnsibleExecuteOptions