doc: update groupList/accountList documentation

This commit is contained in:
Stéphane Lesimple 2021-01-20 09:57:33 +00:00 committed by Stéphane Lesimple
parent fd97845c1c
commit 3dfa77ebab
2 changed files with 22 additions and 2 deletions

View file

@ -9,14 +9,24 @@ List the groups available on this bastion
.. admonition:: usage
:class: cmdusage
--osh groupList [--all]
--osh groupList [--all] [--exclude|--include WILDCARD [--exclude|--include WILDCARD ..]]
.. program:: groupList
.. option:: --all
.. option:: --all
List all groups, even those to which you don't have access
.. option:: --include WILDCARD
Only list groups that match the given WILDCARD string, '*' and '?' are recognized,
this option can be used multiple times to refine results.
.. option:: --exclude WILDCARD
Omit groups that match the given WILDCARD string, '*' and '?' are recognized,
can be used multiple times. Note that --exclude takes precedence over --include

View file

@ -26,5 +26,15 @@ List the bastion accounts
Show more verbose information (SLOW!), you need to be a bastion auditor
.. option:: --include WILDCARD
Only list accounts that match the given WILDCARD string, '*' and '?' are recognized,
this option can be used multiple times to refine results.
.. option:: --exclude WILDCARD
Omit accounts that match the given WILDCARD string, '*' and '?' are recognized,
can be used multiple times. Note that --exclude takes precedence over --include