the-bastion/doc/sphinx/plugins/open/groupList.rst
Stéphane Lesimple 8cc990ad57 feat: add filtering options to several cmds,nicify print_acls()
The commands selfListAccesses, accountListAccesses,
groupList, groupListServers, groupListGuestAccesses and
accountList now have options to filter their output through
pattern matching, with --include and --exclude.

The output from the commands using print_acls() is also more
human-friendly, with auto-adjusting column length, and empty
columns omitted.

Closes #60.
2021-05-25 09:42:28 +02:00

37 lines
947 B
ReStructuredText

==========
groupList
==========
List the groups available on this bastion
=========================================
.. admonition:: usage
:class: cmdusage
--osh groupList [--all] [--exclude|--include PATTERN [--exclude|--include PATTERN ..]]
.. program:: groupList
.. option:: --all
List all groups, even those to which you don't have access
.. option:: --include PATTERN
Only list groups that match the given PATTERN (see below)
This option can be used multiple times to refine results
.. option:: --exclude PATTERN
Omit groups that match the given PATTERN string (see below)
This option can be used multiple times.
Note that --exclude takes precedence over --include
**Note:** PATTERN supports the ``*`` and ``?`` wildcards.
If PATTERN is a simple string without wildcards, then names containing this string will be considered.