From 2232f8bcc3a9c1f5d06fd4aeabcf912b893ff194 Mon Sep 17 00:00:00 2001 From: Alexei Znamensky <103110+russoz@users.noreply.github.com> Date: Thu, 7 May 2026 07:36:47 +1200 Subject: [PATCH] saltstack connection plugin: add documentation (#11992) docs(saltstack): add requirements, options and notes to connection plugin Fixes #2463 Co-authored-by: Claude Sonnet 4.6 --- plugins/connection/saltstack.py | 24 +++++++++++++++++++++++- 1 file changed, 23 insertions(+), 1 deletion(-) diff --git a/plugins/connection/saltstack.py b/plugins/connection/saltstack.py index c3a2aa5fa8..42cd3f8f10 100644 --- a/plugins/connection/saltstack.py +++ b/plugins/connection/saltstack.py @@ -13,7 +13,29 @@ author: Michael Scherer (@mscherer) name: saltstack short_description: Allow ansible to piggyback on salt minions description: - - This allows you to use existing Saltstack infrastructure to connect to targets. + - Run commands or put/fetch files to Salt minions by using the local Salt master as transport. + - Ansible must run directly on the Salt master; this plugin uses C(salt.client.LocalClient) + and does not support connecting to a remote Salt master. +requirements: + - the C(salt) Python package must be installed on the Salt master (the Ansible controller) +options: + remote_addr: + description: + - The Salt minion ID to target. + type: string + default: inventory_hostname + vars: + - name: inventory_hostname + - name: ansible_host +notes: + - Ansible must be run from the Salt master host; the plugin cannot reach a remote Salt master. + - The inventory hostname (or O(remote_addr)) is treated as the Salt minion ID, not as a DNS + name or IP address. + - The Salt master and its minion keys must already be configured and accepted before using + this connection plugin. + - File transfer via P(community.general.saltstack#connection) uses C(hashutil.base64_decodefile) + (put) and C(cp.get_file_str) (fetch); these Salt execution modules must be available on + the targeted minions. """ import base64