IntenseWebs/freeipa
3
0
Fork 0
mirror of https://salsa.debian.org/freeipa-team/freeipa.git synced 2025-02-25 18:55:28 -06:00
Code Issues Packages Projects Releases Wiki Activity

API doc: add note about ipa show-mappings to usage guide

Browse Source 
As discussed in PR #6664, `ipa show-mappings` can be used as a handy way to list
command arguments and options directly through the CLI.

Signed-off-by: Antonio Torres <antorres@redhat.com>
Reviewed-By: Rob Crittenden <rcritten@redhat.com>
This commit is contained in:
Antonio Torres
2023-02-06 12:47:14 +01:00
committed by Rob Crittenden
parent 414b5fe352
commit 53f7a44c5c
1 changed files with 4 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
doc/api/basic_usage.md
View File

@@ -92,6 +92,10 @@ kw = {
api.Command.user_show(*args, **kw)
```
The full list of available arguments and options for each command can be found
in the API Reference. Alternatively, it is possible to see the mapping of CLI
option to API attribute through `ipa show-mappings`.
## Retrieving output
Command output is returned as a Python dictionary. Example shown is the output