diff options
| author | Nullspoon <nullspoon@iohq.net> | 2014-02-27 20:05:44 -0700 |
|---|---|---|
| committer | Nullspoon <nullspoon@iohq.net> | 2014-02-27 20:05:44 -0700 |
| commit | d5a09b2905f294a02006652e3be4db2f68252fb5 (patch) | |
| tree | a0d47140a67b57d2ae3710520af78a9eb042542a /README.md | |
| parent | 97bbc371f9f7e87e9860d22fcb685c8f75c736f1 (diff) | |
| download | keymanage-d5a09b2905f294a02006652e3be4db2f68252fb5.tar.gz keymanage-d5a09b2905f294a02006652e3be4db2f68252fb5.tar.xz | |
Added more to README.md and symlinked to README
Just more documentation on how this currently works.
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 18 |
1 files changed, 15 insertions, 3 deletions
@@ -1,4 +1,16 @@ -keymanage -========= +## keymanage -Manages ssh keys programatically to allow for seamless key swapping/refresh on a specified list of systems. +Provides functionality to push, remove, and swap/refresh ssh keys on a list of systems for the current or specified user. + +### Actions +*All actions are performed on the systems listed in the specified manifest file.* + +1. **push**: Pushes the specified key to the current or specified user on remote systems +2. **remove**: Removes the specified key from the current or specified users on remote systems +3. **update**: Performs a *push - remove* operation. First pushes the new key, using the old key so a password is not required. Then uses the newly pushed key to remove the old key. + +### Arguments +- **-m,--manifest**: Specify a list of systems to perform the action on +- **-k,--key**: Path to the key to perform the action (push, remove) with +- **-i,--id**: Key to use for automated logins. Not used when performing an update. +- **-u,--user**: Username on remote systems to work on (defaults to current user) |