valitydev/salt
14
0
Fork 0
mirror of https://github.com/valitydev/salt.git synced 2024-11-08 09:23:56 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Merge pull request #8897 from terminalmage/docs

Browse Source 
Update salt-key documentation
This commit is contained in:
Pedro Algarvio 2013-11-28 10:10:33 -08:00
commit fe45b91e93
2 changed files with 29 additions and 23 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

38
doc/ref/cli/salt-key.rst
View File

@ -42,56 +42,60 @@ Actions
.. option:: -l ARG, --list=ARG
List the public keys. The args "pre", "un", and "unaccepted" will list
unaccepted/unsigned keys. "acc" or "accepted" will list accepted/signed
keys. "rej" or "rejected" will list rejected keys. Finally, "all" will list
all keys.
List the public keys. The args ``pre``, ``un``, and ``unaccepted`` will
list unaccepted/unsigned keys. ``acc`` or ``accepted`` will list
accepted/signed keys. ``rej`` or ``rejected`` will list rejected keys.
Finally, ``all`` will list all keys.
.. option:: -L, --list-all
List all public keys on this Salt master: accepted, pending,
and rejected.
List all public keys. (Deprecated: use ``--list all``)
.. option:: -a ACCEPT, --accept=ACCEPT
Accept the named minion public key for command execution.
Accept the specified public key (use --include-all to match rejected keys
in addition to pending keys). Globs are supported.
.. option:: -A, --accept-all
Accepts all pending public keys.
Accepts all pending keys.
.. option:: -r REJECT, --reject=REJECT
Reject the named minion public key.
Reject the specified public key (use --include-all to match accepted keys
in addition to pending keys). Globs are supported.
.. option:: -R, --reject-all
Rejects all pending public keys.
Rejects all pending keys.
.. option:: --include-all
Include non-pending keys when accepting/rejecting.
.. option:: -p PRINT, --print=PRINT
Print the specified public key
Print the specified public key.
.. option:: -P, --print-all
Print all public keys
Print all public keys
.. option:: -d DELETE, --delete=DELETE
Delete the named minion key or minion keys matching a glob for command
execution.
Delete the specified key. Globs are supported.
.. option:: -D, --delete-all
Delete all keys
Delete all keys.
.. option:: -f FINGER, --finger=FINGER
Print the named key's fingerprint
Print the specified key's fingerprint.
.. option:: -F, --finger-all
Print all key's fingerprints
Print all keys' fingerprints.
Key Generation Options

14
salt/utils/parsers.py
View File

@ -1611,14 +1611,15 @@ class SaltKeyOptionParser(OptionParser, ConfigDirMixIn, MergeConfigMixIn,
'-L', '--list-all',
default=False,
action='store_true',
help='List all public keys. Deprecated: use "--list all"'
help='List all public keys. (Deprecated: use "--list all")'
)
actions_group.add_option(
'-a', '--accept',
default='',
help='Accept the specified public key (use --include-all to '
'match rejected keys in addition to pending keys)'
'match rejected keys in addition to pending keys). Globs are '
'supported.'
)
actions_group.add_option(
@ -1632,7 +1633,8 @@ class SaltKeyOptionParser(OptionParser, ConfigDirMixIn, MergeConfigMixIn,
'-r', '--reject',
default='',
help='Reject the specified public key (use --include-all to '
'match accepted keys in addition to pending keys)'
'match accepted keys in addition to pending keys). Globs are '
'supported.'
)
actions_group.add_option(
@ -1665,7 +1667,7 @@ class SaltKeyOptionParser(OptionParser, ConfigDirMixIn, MergeConfigMixIn,
actions_group.add_option(
'-d', '--delete',
default='',
help='Delete the named key'
help='Delete the specified key. Globs are supported.'
)
actions_group.add_option(
@ -1678,14 +1680,14 @@ class SaltKeyOptionParser(OptionParser, ConfigDirMixIn, MergeConfigMixIn,
actions_group.add_option(
'-f', '--finger',
default='',
help='Print the named key\'s fingerprint'
help='Print the specified key\'s fingerprint'
)
actions_group.add_option(
'-F', '--finger-all',
default=False,
action='store_true',
help='Print all key\'s fingerprints'
help='Print all keys\' fingerprints'
)
self.add_option_group(actions_group)