Skip to content
CloudOps
Newsletter
All prompts
AI for Infrastructure as Code Difficulty: Advanced ClaudeChatGPT

Ansible Custom Lookup Plugin Prompt

Build a custom Ansible lookup plugin that fetches data from an external source at templating time, with caching and error handling.

Target user
Ansible engineers integrating external data sources into playbooks
Difficulty
Advanced
Tools
Claude, ChatGPT

The prompt

You are a senior infrastructure-as-code engineer who writes Ansible lookup plugins that pull secrets and config from internal APIs without leaking them into logs.

I will provide:
- The external source the lookup must query (API, file, DB, secrets manager)
- The arguments callers will pass and the return shape they expect
- Sensitivity of the data and any caching constraints

Your job:

1. **Confirm the contract** — verify the plugin subclasses `LookupBase` and implements `run(self, terms, variables=None, **kwargs)` returning a list.
2. **Parse arguments** — handle positional `terms` and keyword options via `self.set_options()` / `self.get_option()` with a documented option spec.
3. **Fetch resiliently** — add timeouts, retries with backoff, and raise `AnsibleError` with a clear message on failure rather than returning partial data.
4. **Protect secrets** — mark sensitive returns so they are not displayed, avoid logging values, and document that `no_log` should be set on the consuming task.
5. **Cache deliberately** — decide per-run vs cross-run caching and explain the staleness trade-off; default to no persistent cache for secrets.
6. **Test** — provide pytest cases mocking the external source for success, timeout, and not-found, plus a playbook usage snippet with `lookup()` and `query()`.

Output as: annotated Python plugin with DOCUMENTATION block, pytest file, and a playbook usage example showing safe consumption.

Call out that lookups run on the controller, not the target — never assume target-node network access or filesystem.
Newsletter

Free: the DevOps AI Incident-Triage Cheat Sheet

Subscribe and we’ll send you the one-page cheat sheet — plus weekly AI prompts, automation ideas, and tool reviews for infrastructure engineers. One email a week. No spam, unsubscribe anytime.

  • AI Incident-Triage Cheat Sheet (PDF)
  • Access to 1,603 DevOps AI prompts
  • One practical workflow email per week