mirror of
https://salsa.debian.org/freeipa-team/freeipa.git
synced 2024-12-23 07:33:27 -06:00
988cb5a535
Extend the 'make api' target so that we also build an API Reference in Markdown format. One template for each command gets generated. These templates include all of the command details (arguments, options and outputs), and then a section for manually-added notes such as semantics or version differences. Every time the docs are regenerated, these notes will be added if they exist. Signed-off-by: Antonio Torres <antorres@redhat.com> Reviewed-By: Alexander Bokovoy <abokovoy@redhat.com> Reviewed-By: Rob Crittenden <rcritten@redhat.com>
32 lines
687 B
Markdown
32 lines
687 B
Markdown
[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.)
|
|
# host_remove_principal
|
|
Remove principal alias from a host entry
|
|
|
|
### Arguments
|
|
|Name|Type|Required
|
|
|-|-|-
|
|
|fqdn|:ref:`Str<Str>`|True
|
|
|krbprincipalname|:ref:`Principal<Principal>`|True
|
|
|
|
### Options
|
|
* all : :ref:`Flag<Flag>` **(Required)**
|
|
* Default: False
|
|
* raw : :ref:`Flag<Flag>` **(Required)**
|
|
* Default: False
|
|
* no_members : :ref:`Flag<Flag>` **(Required)**
|
|
* Default: False
|
|
* version : :ref:`Str<Str>`
|
|
|
|
### Output
|
|
|Name|Type
|
|
|-|-
|
|
|result|Entry
|
|
|summary|Output
|
|
|value|PrimaryKey
|
|
|
|
[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end)
|
|
### Semantics
|
|
|
|
### Notes
|
|
|
|
### Version differences |