Merge pull request saltstack#2043 from gekitsuu/develop

thatch45 · thatch45 · commit 07fdb35cd753 · 2012-09-19T10:46:37.000-07:00
Made the docstring a bit clearer about the format of the key. Commonly
diff --git a/salt/modules/ssh.py b/salt/modules/ssh.py
@@ -337,7 +337,10 @@ def set_auth_key(
         options=[],
         config='.ssh/authorized_keys'):
     '''
-    Add a key to the authorized_keys file
+    Add a key to the authorized_keys file. The "key" parameter must only be the
+    string of text that is the encoded key. If the key begins with "ssh-rsa"
+    or ends with user@host, remove those from the key before passing it to this
+    function.
 
     CLI Example::
 
