doc: generate API Reference

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: Rob Crittenden <rcritten@redhat.com>
Reviewed-By: Alexander Bokovoy <abokovoy@redhat.com>
This commit is contained in:
Antonio Torres 2022-08-22 10:30:10 +02:00 committed by Florence Blanc-Renaud
parent 5631e47470
commit 5626976ef0
557 changed files with 18140 additions and 5 deletions

3
doc/api/A6Record.md Normal file
View File

@ -0,0 +1,3 @@
.. _A6Record:
# A6Record

3
doc/api/AAAARecord.md Normal file
View File

@ -0,0 +1,3 @@
.. _AAAARecord:
# AAAARecord

3
doc/api/AFSDBRecord.md Normal file
View File

@ -0,0 +1,3 @@
.. _AFSDBRecord:
# AFSDBRecord

3
doc/api/APLRecord.md Normal file
View File

@ -0,0 +1,3 @@
.. _APLRecord:
# APLRecord

3
doc/api/ARecord.md Normal file
View File

@ -0,0 +1,3 @@
.. _ARecord:
# ARecord

3
doc/api/AccessTime.md Normal file
View File

@ -0,0 +1,3 @@
.. _AccessTime:
# AccessTime

3
doc/api/Any.md Normal file
View File

@ -0,0 +1,3 @@
.. _Any:
# Any

3
doc/api/BinaryFile.md Normal file
View File

@ -0,0 +1,3 @@
.. _BinaryFile:
# BinaryFile

3
doc/api/Bool.md Normal file
View File

@ -0,0 +1,3 @@
.. _Bool:
# Bool

3
doc/api/Bytes.md Normal file
View File

@ -0,0 +1,3 @@
.. _Bytes:
# Bytes

3
doc/api/BytesEnum.md Normal file
View File

@ -0,0 +1,3 @@
.. _BytesEnum:
# BytesEnum

3
doc/api/CERTRecord.md Normal file
View File

@ -0,0 +1,3 @@
.. _CERTRecord:
# CERTRecord

3
doc/api/CNAMERecord.md Normal file
View File

@ -0,0 +1,3 @@
.. _CNAMERecord:
# CNAMERecord

3
doc/api/Certificate.md Normal file
View File

@ -0,0 +1,3 @@
.. _Certificate:
# Certificate

View File

@ -0,0 +1,3 @@
.. _CertificateSigningRequest:
# CertificateSigningRequest

3
doc/api/DHCIDRecord.md Normal file
View File

@ -0,0 +1,3 @@
.. _DHCIDRecord:
# DHCIDRecord

3
doc/api/DLVRecord.md Normal file
View File

@ -0,0 +1,3 @@
.. _DLVRecord:
# DLVRecord

3
doc/api/DNAMERecord.md Normal file
View File

@ -0,0 +1,3 @@
.. _DNAMERecord:
# DNAMERecord

3
doc/api/DNOrURL.md Normal file
View File

@ -0,0 +1,3 @@
.. _DNOrURL:
# DNOrURL

3
doc/api/DNParam.md Normal file
View File

@ -0,0 +1,3 @@
.. _DNParam:
# DNParam

3
doc/api/DNSNameParam.md Normal file
View File

@ -0,0 +1,3 @@
.. _DNSNameParam:
# DNSNameParam

3
doc/api/DNSRecord.md Normal file
View File

@ -0,0 +1,3 @@
.. _DNSRecord:
# DNSRecord

3
doc/api/DSRecord.md Normal file
View File

@ -0,0 +1,3 @@
.. _DSRecord:
# DSRecord

3
doc/api/Data.md Normal file
View File

@ -0,0 +1,3 @@
.. _Data:
# Data

3
doc/api/DateTime.md Normal file
View File

@ -0,0 +1,3 @@
.. _DateTime:
# DateTime

3
doc/api/Decimal.md Normal file
View File

@ -0,0 +1,3 @@
.. _Decimal:
# Decimal

3
doc/api/Dict.md Normal file
View File

@ -0,0 +1,3 @@
.. _Dict:
# Dict

3
doc/api/Enum.md Normal file
View File

@ -0,0 +1,3 @@
.. _Enum:
# Enum

3
doc/api/File.md Normal file
View File

@ -0,0 +1,3 @@
.. _File:
# File

3
doc/api/Flag.md Normal file
View File

@ -0,0 +1,3 @@
.. _Flag:
# Flag

3
doc/api/ForwardRecord.md Normal file
View File

@ -0,0 +1,3 @@
.. _ForwardRecord:
# ForwardRecord

3
doc/api/HINFORecord.md Normal file
View File

@ -0,0 +1,3 @@
.. _HINFORecord:
# HINFORecord

3
doc/api/HIPRecord.md Normal file
View File

@ -0,0 +1,3 @@
.. _HIPRecord:
# HIPRecord

3
doc/api/HostPassword.md Normal file
View File

@ -0,0 +1,3 @@
.. _HostPassword:
# HostPassword

3
doc/api/IA5Str.md Normal file
View File

@ -0,0 +1,3 @@
.. _IA5Str:
# IA5Str

View File

@ -0,0 +1,3 @@
.. _IPSECKEYRecord:
# IPSECKEYRecord

3
doc/api/Int.md Normal file
View File

@ -0,0 +1,3 @@
.. _Int:
# Int

3
doc/api/IntEnum.md Normal file
View File

@ -0,0 +1,3 @@
.. _IntEnum:
# IntEnum

3
doc/api/KEYRecord.md Normal file
View File

@ -0,0 +1,3 @@
.. _KEYRecord:
# KEYRecord

3
doc/api/KXRecord.md Normal file
View File

@ -0,0 +1,3 @@
.. _KXRecord:
# KXRecord

3
doc/api/LOCRecord.md Normal file
View File

@ -0,0 +1,3 @@
.. _LOCRecord:
# LOCRecord

3
doc/api/MDRecord.md Normal file
View File

@ -0,0 +1,3 @@
.. _MDRecord:
# MDRecord

3
doc/api/MINFORecord.md Normal file
View File

@ -0,0 +1,3 @@
.. _MINFORecord:
# MINFORecord

3
doc/api/MXRecord.md Normal file
View File

@ -0,0 +1,3 @@
.. _MXRecord:
# MXRecord

3
doc/api/NAPTRRecord.md Normal file
View File

@ -0,0 +1,3 @@
.. _NAPTRRecord:
# NAPTRRecord

3
doc/api/NSECRecord.md Normal file
View File

@ -0,0 +1,3 @@
.. _NSECRecord:
# NSECRecord

3
doc/api/NSRecord.md Normal file
View File

@ -0,0 +1,3 @@
.. _NSRecord:
# NSRecord

3
doc/api/NXTRecord.md Normal file
View File

@ -0,0 +1,3 @@
.. _NXTRecord:
# NXTRecord

3
doc/api/Number.md Normal file
View File

@ -0,0 +1,3 @@
.. _Number:
# Number

3
doc/api/OTPTokenKey.md Normal file
View File

@ -0,0 +1,3 @@
.. _OTPTokenKey:
# OTPTokenKey

3
doc/api/PTRRecord.md Normal file
View File

@ -0,0 +1,3 @@
.. _PTRRecord:
# PTRRecord

3
doc/api/Password.md Normal file
View File

@ -0,0 +1,3 @@
.. _Password:
# Password

3
doc/api/Principal.md Normal file
View File

@ -0,0 +1,3 @@
.. _Principal:
# Principal

3
doc/api/RPRecord.md Normal file
View File

@ -0,0 +1,3 @@
.. _RPRecord:
# RPRecord

3
doc/api/RRSIGRecord.md Normal file
View File

@ -0,0 +1,3 @@
.. _RRSIGRecord:
# RRSIGRecord

3
doc/api/SIGRecord.md Normal file
View File

@ -0,0 +1,3 @@
.. _SIGRecord:
# SIGRecord

3
doc/api/SPFRecord.md Normal file
View File

@ -0,0 +1,3 @@
.. _SPFRecord:
# SPFRecord

3
doc/api/SRVRecord.md Normal file
View File

@ -0,0 +1,3 @@
.. _SRVRecord:
# SRVRecord

3
doc/api/SSHFPRecord.md Normal file
View File

@ -0,0 +1,3 @@
.. _SSHFPRecord:
# SSHFPRecord

3
doc/api/SerialNumber.md Normal file
View File

@ -0,0 +1,3 @@
.. _SerialNumber:
# SerialNumber

3
doc/api/Str.md Normal file
View File

@ -0,0 +1,3 @@
.. _Str:
# Str

3
doc/api/StrEnum.md Normal file
View File

@ -0,0 +1,3 @@
.. _StrEnum:
# StrEnum

3
doc/api/TLSARecord.md Normal file
View File

@ -0,0 +1,3 @@
.. _TLSARecord:
# TLSARecord

3
doc/api/TXTRecord.md Normal file
View File

@ -0,0 +1,3 @@
.. _TXTRecord:
# TXTRecord

3
doc/api/URIRecord.md Normal file
View File

@ -0,0 +1,3 @@
.. _URIRecord:
# URIRecord

View File

@ -0,0 +1,3 @@
.. _UnsupportedDNSRecord:
# UnsupportedDNSRecord

45
doc/api/aci_add.md Normal file
View File

@ -0,0 +1,45 @@
[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.)
# aci_add
Create new ACI.
### Arguments
|Name|Type|Required
|-|-|-
|aciname|:ref:`Str<Str>`|True
### Options
* permissions : :ref:`Str<Str>` **(Required)**
* aciprefix : :ref:`StrEnum<StrEnum>` **(Required)**
* Values: ('permission', 'delegation', 'selfservice', 'none')
* all : :ref:`Flag<Flag>` **(Required)**
* Default: False
* raw : :ref:`Flag<Flag>` **(Required)**
* Default: False
* permission : :ref:`Str<Str>`
* group : :ref:`Str<Str>`
* attrs : :ref:`Str<Str>`
* type : :ref:`StrEnum<StrEnum>`
* Values: ('user', 'group', 'host', 'service', 'hostgroup', 'netgroup', 'dnsrecord')
* memberof : :ref:`Str<Str>`
* filter : :ref:`Str<Str>`
* subtree : :ref:`Str<Str>`
* targetgroup : :ref:`Str<Str>`
* selfaci : :ref:`Flag<Flag>`
* Default: False
* test : :ref:`Flag<Flag>`
* 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

27
doc/api/aci_del.md Normal file
View File

@ -0,0 +1,27 @@
[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.)
# aci_del
Delete ACI.
### Arguments
|Name|Type|Required
|-|-|-
|aciname|:ref:`Str<Str>`|True
### Options
* aciprefix : :ref:`StrEnum<StrEnum>` **(Required)**
* Values: ('permission', 'delegation', 'selfservice', 'none')
* version : :ref:`Str<Str>`
### Output
|Name|Type
|-|-
|result|Output
|summary|Output
|value|PrimaryKey
[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end)
### Semantics
### Notes
### Version differences

65
doc/api/aci_find.md Normal file
View File

@ -0,0 +1,65 @@
[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.)
# aci_find
Search for ACIs.
Returns a list of ACIs
EXAMPLES:
To find all ACIs that apply directly to members of the group ipausers:
ipa aci-find --memberof=ipausers
To find all ACIs that grant add access:
ipa aci-find --permissions=add
Note that the find command only looks for the given text in the set of
ACIs, it does not evaluate the ACIs to see if something would apply.
For example, searching on memberof=ipausers will find all ACIs that
have ipausers as a memberof. There may be other ACIs that apply to
members of that group indirectly.
### Arguments
|Name|Type|Required
|-|-|-
|criteria|:ref:`Str<Str>`|False
### Options
* all : :ref:`Flag<Flag>` **(Required)**
* Default: False
* raw : :ref:`Flag<Flag>` **(Required)**
* Default: False
* aciname : :ref:`Str<Str>`
* permission : :ref:`Str<Str>`
* group : :ref:`Str<Str>`
* permissions : :ref:`Str<Str>`
* attrs : :ref:`Str<Str>`
* type : :ref:`StrEnum<StrEnum>`
* Values: ('user', 'group', 'host', 'service', 'hostgroup', 'netgroup', 'dnsrecord')
* memberof : :ref:`Str<Str>`
* filter : :ref:`Str<Str>`
* subtree : :ref:`Str<Str>`
* targetgroup : :ref:`Str<Str>`
* selfaci : :ref:`Bool<Bool>`
* Default: False
* aciprefix : :ref:`StrEnum<StrEnum>`
* Values: ('permission', 'delegation', 'selfservice', 'none')
* pkey_only : :ref:`Flag<Flag>`
* Default: False
* version : :ref:`Str<Str>`
### Output
|Name|Type
|-|-
|count|Output
|result|ListOfEntries
|summary|Output
|truncated|Output
[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end)
### Semantics
### Notes
### Version differences

43
doc/api/aci_mod.md Normal file
View File

@ -0,0 +1,43 @@
[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.)
# aci_mod
Modify ACI.
### Arguments
|Name|Type|Required
|-|-|-
|aciname|:ref:`Str<Str>`|True
### Options
* aciprefix : :ref:`StrEnum<StrEnum>` **(Required)**
* Values: ('permission', 'delegation', 'selfservice', 'none')
* all : :ref:`Flag<Flag>` **(Required)**
* Default: False
* raw : :ref:`Flag<Flag>` **(Required)**
* Default: False
* permission : :ref:`Str<Str>`
* group : :ref:`Str<Str>`
* permissions : :ref:`Str<Str>`
* attrs : :ref:`Str<Str>`
* type : :ref:`StrEnum<StrEnum>`
* Values: ('user', 'group', 'host', 'service', 'hostgroup', 'netgroup', 'dnsrecord')
* memberof : :ref:`Str<Str>`
* filter : :ref:`Str<Str>`
* subtree : :ref:`Str<Str>`
* targetgroup : :ref:`Str<Str>`
* selfaci : :ref:`Flag<Flag>`
* 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

44
doc/api/aci_rename.md Normal file
View File

@ -0,0 +1,44 @@
[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.)
# aci_rename
Rename an ACI.
### Arguments
|Name|Type|Required
|-|-|-
|aciname|:ref:`Str<Str>`|True
### Options
* aciprefix : :ref:`StrEnum<StrEnum>` **(Required)**
* Values: ('permission', 'delegation', 'selfservice', 'none')
* newname : :ref:`Str<Str>` **(Required)**
* all : :ref:`Flag<Flag>` **(Required)**
* Default: False
* raw : :ref:`Flag<Flag>` **(Required)**
* Default: False
* permission : :ref:`Str<Str>`
* group : :ref:`Str<Str>`
* permissions : :ref:`Str<Str>`
* attrs : :ref:`Str<Str>`
* type : :ref:`StrEnum<StrEnum>`
* Values: ('user', 'group', 'host', 'service', 'hostgroup', 'netgroup', 'dnsrecord')
* memberof : :ref:`Str<Str>`
* filter : :ref:`Str<Str>`
* subtree : :ref:`Str<Str>`
* targetgroup : :ref:`Str<Str>`
* selfaci : :ref:`Flag<Flag>`
* 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

32
doc/api/aci_show.md Normal file
View File

@ -0,0 +1,32 @@
[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.)
# aci_show
Display a single ACI given an ACI name.
### Arguments
|Name|Type|Required
|-|-|-
|aciname|:ref:`Str<Str>`|True
### Options
* aciprefix : :ref:`StrEnum<StrEnum>` **(Required)**
* Values: ('permission', 'delegation', 'selfservice', 'none')
* all : :ref:`Flag<Flag>` **(Required)**
* Default: False
* raw : :ref:`Flag<Flag>` **(Required)**
* Default: False
* location : :ref:`DNParam<DNParam>`
* 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

View File

@ -0,0 +1,21 @@
[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.)
# adtrust_is_enabled
Determine whether ipa-adtrust-install has been run on this system
### Arguments
No arguments.
### Options
* version : :ref:`Str<Str>`
### Output
|Name|Type
|-|-
|result|Output
[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end)
### Semantics
### Notes
### Version differences

36
doc/api/automember_add.md Normal file
View File

@ -0,0 +1,36 @@
[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.)
# automember_add
Add an automember rule.
### Arguments
|Name|Type|Required
|-|-|-
|cn|:ref:`Str<Str>`|True
### Options
* type : :ref:`StrEnum<StrEnum>` **(Required)**
* Values: ('group', 'hostgroup')
* all : :ref:`Flag<Flag>` **(Required)**
* Default: False
* raw : :ref:`Flag<Flag>` **(Required)**
* Default: False
* description : :ref:`Str<Str>`
* setattr : :ref:`Str<Str>`
* addattr : :ref:`Str<Str>`
* 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

View File

@ -0,0 +1,39 @@
[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.)
# automember_add_condition
Add conditions to an automember rule.
### Arguments
|Name|Type|Required
|-|-|-
|cn|:ref:`Str<Str>`|True
### Options
* key : :ref:`Str<Str>` **(Required)**
* type : :ref:`StrEnum<StrEnum>` **(Required)**
* Values: ('group', 'hostgroup')
* all : :ref:`Flag<Flag>` **(Required)**
* Default: False
* raw : :ref:`Flag<Flag>` **(Required)**
* Default: False
* description : :ref:`Str<Str>`
* automemberinclusiveregex : :ref:`Str<Str>`
* automemberexclusiveregex : :ref:`Str<Str>`
* version : :ref:`Str<Str>`
### Output
|Name|Type
|-|-
|completed|Output
|failed|Output
|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

View File

@ -0,0 +1,31 @@
[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.)
# automember_default_group_remove
Remove default (fallback) group for all unmatched entries.
### Arguments
No arguments.
### Options
* type : :ref:`StrEnum<StrEnum>` **(Required)**
* Values: ('group', 'hostgroup')
* all : :ref:`Flag<Flag>` **(Required)**
* Default: False
* raw : :ref:`Flag<Flag>` **(Required)**
* Default: False
* version : :ref:`Str<Str>`
### Output
|Name|Type
|-|-
|result|Entry
|summary|Output
|value|Output
[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end)
### Semantics
### Notes
### Version differences

View File

@ -0,0 +1,32 @@
[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.)
# automember_default_group_set
Set default (fallback) group for all unmatched entries.
### Arguments
No arguments.
### Options
* automemberdefaultgroup : :ref:`Str<Str>` **(Required)**
* type : :ref:`StrEnum<StrEnum>` **(Required)**
* Values: ('group', 'hostgroup')
* all : :ref:`Flag<Flag>` **(Required)**
* Default: False
* raw : :ref:`Flag<Flag>` **(Required)**
* Default: False
* version : :ref:`Str<Str>`
### Output
|Name|Type
|-|-
|result|Entry
|summary|Output
|value|Output
[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end)
### Semantics
### Notes
### Version differences

View File

@ -0,0 +1,31 @@
[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.)
# automember_default_group_show
Display information about the default (fallback) automember groups.
### Arguments
No arguments.
### Options
* type : :ref:`StrEnum<StrEnum>` **(Required)**
* Values: ('group', 'hostgroup')
* all : :ref:`Flag<Flag>` **(Required)**
* Default: False
* raw : :ref:`Flag<Flag>` **(Required)**
* Default: False
* version : :ref:`Str<Str>`
### Output
|Name|Type
|-|-
|result|Entry
|summary|Output
|value|Output
[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end)
### Semantics
### Notes
### Version differences

29
doc/api/automember_del.md Normal file
View File

@ -0,0 +1,29 @@
[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.)
# automember_del
Delete an automember rule.
### Arguments
|Name|Type|Required
|-|-|-
|cn|:ref:`Str<Str>`|True
### Options
* type : :ref:`StrEnum<StrEnum>` **(Required)**
* Values: ('group', 'hostgroup')
* version : :ref:`Str<Str>`
### Output
|Name|Type
|-|-
|result|Output
|summary|Output
|value|ListOfPrimaryKeys
[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end)
### Semantics
### Notes
### Version differences

View File

@ -0,0 +1,37 @@
[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.)
# automember_find
Search for automember rules.
### Arguments
|Name|Type|Required
|-|-|-
|criteria|:ref:`Str<Str>`|False
### Options
* type : :ref:`StrEnum<StrEnum>` **(Required)**
* Values: ('group', 'hostgroup')
* all : :ref:`Flag<Flag>` **(Required)**
* Default: False
* raw : :ref:`Flag<Flag>` **(Required)**
* Default: False
* description : :ref:`Str<Str>`
* version : :ref:`Str<Str>`
* pkey_only : :ref:`Flag<Flag>`
* Default: False
### Output
|Name|Type
|-|-
|count|Output
|result|ListOfEntries
|summary|Output
|truncated|Output
[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end)
### Semantics
### Notes
### Version differences

View File

@ -0,0 +1,40 @@
[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.)
# automember_find_orphans
Search for orphan automember rules. The command might need to be run as
a privileged user user to get all orphan rules.
### Arguments
|Name|Type|Required
|-|-|-
|criteria|:ref:`Str<Str>`|False
### Options
* type : :ref:`StrEnum<StrEnum>` **(Required)**
* Values: ('group', 'hostgroup')
* all : :ref:`Flag<Flag>` **(Required)**
* Default: False
* raw : :ref:`Flag<Flag>` **(Required)**
* Default: False
* description : :ref:`Str<Str>`
* remove : :ref:`Flag<Flag>`
* Default: False
* version : :ref:`Str<Str>`
* pkey_only : :ref:`Flag<Flag>`
* Default: False
### Output
|Name|Type
|-|-
|count|Output
|result|ListOfEntries
|summary|Output
|truncated|Output
[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end)
### Semantics
### Notes
### Version differences

39
doc/api/automember_mod.md Normal file
View File

@ -0,0 +1,39 @@
[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.)
# automember_mod
Modify an automember rule.
### Arguments
|Name|Type|Required
|-|-|-
|cn|:ref:`Str<Str>`|True
### Options
* rights : :ref:`Flag<Flag>` **(Required)**
* Default: False
* type : :ref:`StrEnum<StrEnum>` **(Required)**
* Values: ('group', 'hostgroup')
* all : :ref:`Flag<Flag>` **(Required)**
* Default: False
* raw : :ref:`Flag<Flag>` **(Required)**
* Default: False
* description : :ref:`Str<Str>`
* setattr : :ref:`Str<Str>`
* addattr : :ref:`Str<Str>`
* delattr : :ref:`Str<Str>`
* 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

View File

@ -0,0 +1,33 @@
[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.)
# automember_rebuild
Rebuild auto membership.
### Arguments
No arguments.
### Options
* all : :ref:`Flag<Flag>` **(Required)**
* Default: False
* raw : :ref:`Flag<Flag>` **(Required)**
* Default: False
* type : :ref:`StrEnum<StrEnum>`
* Values: ('group', 'hostgroup')
* users : :ref:`Str<Str>`
* hosts : :ref:`Str<Str>`
* no_wait : :ref:`Flag<Flag>`
* 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

View File

@ -0,0 +1,39 @@
[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.)
# automember_remove_condition
Remove conditions from an automember rule.
### Arguments
|Name|Type|Required
|-|-|-
|cn|:ref:`Str<Str>`|True
### Options
* key : :ref:`Str<Str>` **(Required)**
* type : :ref:`StrEnum<StrEnum>` **(Required)**
* Values: ('group', 'hostgroup')
* all : :ref:`Flag<Flag>` **(Required)**
* Default: False
* raw : :ref:`Flag<Flag>` **(Required)**
* Default: False
* description : :ref:`Str<Str>`
* automemberinclusiveregex : :ref:`Str<Str>`
* automemberexclusiveregex : :ref:`Str<Str>`
* version : :ref:`Str<Str>`
### Output
|Name|Type
|-|-
|completed|Output
|failed|Output
|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

View File

@ -0,0 +1,33 @@
[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.)
# automember_show
Display information about an automember rule.
### Arguments
|Name|Type|Required
|-|-|-
|cn|:ref:`Str<Str>`|True
### Options
* type : :ref:`StrEnum<StrEnum>` **(Required)**
* Values: ('group', 'hostgroup')
* all : :ref:`Flag<Flag>` **(Required)**
* Default: False
* raw : :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

View File

@ -0,0 +1,34 @@
[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.)
# automountkey_add
Create a new automount key.
### Arguments
|Name|Type|Required
|-|-|-
|automountlocationcn|:ref:`Str<Str>`|True
|automountmapautomountmapname|:ref:`IA5Str<IA5Str>`|True
### Options
* automountkey : :ref:`IA5Str<IA5Str>` **(Required)**
* automountinformation : :ref:`IA5Str<IA5Str>` **(Required)**
* all : :ref:`Flag<Flag>` **(Required)**
* Default: False
* raw : :ref:`Flag<Flag>` **(Required)**
* Default: False
* setattr : :ref:`Str<Str>`
* addattr : :ref:`Str<Str>`
* 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

View File

@ -0,0 +1,30 @@
[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.)
# automountkey_del
Delete an automount key.
### Arguments
|Name|Type|Required
|-|-|-
|automountlocationcn|:ref:`Str<Str>`|True
|automountmapautomountmapname|:ref:`IA5Str<IA5Str>`|True
### Options
* continue : :ref:`Flag<Flag>` **(Required)**
* Default: False
* automountkey : :ref:`IA5Str<IA5Str>` **(Required)**
* automountinformation : :ref:`IA5Str<IA5Str>`
* version : :ref:`Str<Str>`
### Output
|Name|Type
|-|-
|result|Output
|summary|Output
|value|ListOfPrimaryKeys
[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end)
### Semantics
### Notes
### Version differences

View File

@ -0,0 +1,36 @@
[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.)
# automountkey_find
Search for an automount key.
### Arguments
|Name|Type|Required
|-|-|-
|automountlocationcn|:ref:`Str<Str>`|True
|automountmapautomountmapname|:ref:`IA5Str<IA5Str>`|True
|criteria|:ref:`Str<Str>`|False
### Options
* all : :ref:`Flag<Flag>` **(Required)**
* Default: False
* raw : :ref:`Flag<Flag>` **(Required)**
* Default: False
* automountkey : :ref:`IA5Str<IA5Str>`
* automountinformation : :ref:`IA5Str<IA5Str>`
* timelimit : :ref:`Int<Int>`
* sizelimit : :ref:`Int<Int>`
* version : :ref:`Str<Str>`
### Output
|Name|Type
|-|-
|count|Output
|result|ListOfEntries
|summary|Output
|truncated|Output
[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end)
### Semantics
### Notes
### Version differences

View File

@ -0,0 +1,39 @@
[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.)
# automountkey_mod
Modify an automount key.
### Arguments
|Name|Type|Required
|-|-|-
|automountlocationcn|:ref:`Str<Str>`|True
|automountmapautomountmapname|:ref:`IA5Str<IA5Str>`|True
### Options
* automountkey : :ref:`IA5Str<IA5Str>` **(Required)**
* rights : :ref:`Flag<Flag>` **(Required)**
* Default: False
* all : :ref:`Flag<Flag>` **(Required)**
* Default: False
* raw : :ref:`Flag<Flag>` **(Required)**
* Default: False
* automountinformation : :ref:`IA5Str<IA5Str>`
* setattr : :ref:`Str<Str>`
* addattr : :ref:`Str<Str>`
* delattr : :ref:`Str<Str>`
* newautomountinformation : :ref:`IA5Str<IA5Str>`
* version : :ref:`Str<Str>`
* rename : :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

View File

@ -0,0 +1,34 @@
[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.)
# automountkey_show
Display an automount key.
### Arguments
|Name|Type|Required
|-|-|-
|automountlocationcn|:ref:`Str<Str>`|True
|automountmapautomountmapname|:ref:`IA5Str<IA5Str>`|True
### Options
* rights : :ref:`Flag<Flag>` **(Required)**
* Default: False
* automountkey : :ref:`IA5Str<IA5Str>` **(Required)**
* all : :ref:`Flag<Flag>` **(Required)**
* Default: False
* raw : :ref:`Flag<Flag>` **(Required)**
* Default: False
* automountinformation : :ref:`IA5Str<IA5Str>`
* 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

View File

@ -0,0 +1,31 @@
[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.)
# automountlocation_add
Create a new automount location.
### Arguments
|Name|Type|Required
|-|-|-
|cn|:ref:`Str<Str>`|True
### Options
* all : :ref:`Flag<Flag>` **(Required)**
* Default: False
* raw : :ref:`Flag<Flag>` **(Required)**
* Default: False
* setattr : :ref:`Str<Str>`
* addattr : :ref:`Str<Str>`
* 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

View File

@ -0,0 +1,27 @@
[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.)
# automountlocation_del
Delete an automount location.
### Arguments
|Name|Type|Required
|-|-|-
|cn|:ref:`Str<Str>`|True
### Options
* continue : :ref:`Flag<Flag>` **(Required)**
* Default: False
* version : :ref:`Str<Str>`
### Output
|Name|Type
|-|-
|result|Output
|summary|Output
|value|ListOfPrimaryKeys
[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end)
### Semantics
### Notes
### Version differences

View File

@ -0,0 +1,35 @@
[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.)
# automountlocation_find
Search for an automount location.
### Arguments
|Name|Type|Required
|-|-|-
|criteria|:ref:`Str<Str>`|False
### Options
* all : :ref:`Flag<Flag>` **(Required)**
* Default: False
* raw : :ref:`Flag<Flag>` **(Required)**
* Default: False
* cn : :ref:`Str<Str>`
* timelimit : :ref:`Int<Int>`
* sizelimit : :ref:`Int<Int>`
* version : :ref:`Str<Str>`
* pkey_only : :ref:`Flag<Flag>`
* Default: False
### Output
|Name|Type
|-|-
|count|Output
|result|ListOfEntries
|summary|Output
|truncated|Output
[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end)
### Semantics
### Notes
### Version differences

View File

@ -0,0 +1,31 @@
[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.)
# automountlocation_show
Display an automount location.
### Arguments
|Name|Type|Required
|-|-|-
|cn|:ref:`Str<Str>`|True
### Options
* rights : :ref:`Flag<Flag>` **(Required)**
* Default: False
* all : :ref:`Flag<Flag>` **(Required)**
* Default: False
* raw : :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

View File

@ -0,0 +1,23 @@
[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.)
# automountlocation_tofiles
Generate automount files for a specific location.
### Arguments
|Name|Type|Required
|-|-|-
|cn|:ref:`Str<Str>`|True
### Options
* version : :ref:`Str<Str>`
### Output
|Name|Type
|-|-
|result|Output
[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end)
### Semantics
### Notes
### Version differences

View File

@ -0,0 +1,33 @@
[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.)
# automountmap_add
Create a new automount map.
### Arguments
|Name|Type|Required
|-|-|-
|automountlocationcn|:ref:`Str<Str>`|True
|automountmapname|:ref:`IA5Str<IA5Str>`|True
### Options
* all : :ref:`Flag<Flag>` **(Required)**
* Default: False
* raw : :ref:`Flag<Flag>` **(Required)**
* Default: False
* description : :ref:`Str<Str>`
* setattr : :ref:`Str<Str>`
* addattr : :ref:`Str<Str>`
* 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

View File

@ -0,0 +1,36 @@
[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.)
# automountmap_add_indirect
Create a new indirect mount point.
### Arguments
|Name|Type|Required
|-|-|-
|automountlocationcn|:ref:`Str<Str>`|True
|automountmapname|:ref:`IA5Str<IA5Str>`|True
### Options
* key : :ref:`Str<Str>` **(Required)**
* all : :ref:`Flag<Flag>` **(Required)**
* Default: False
* raw : :ref:`Flag<Flag>` **(Required)**
* Default: False
* description : :ref:`Str<Str>`
* setattr : :ref:`Str<Str>`
* addattr : :ref:`Str<Str>`
* parentmap : :ref:`Str<Str>`
* Default: auto.master
* 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

View File

@ -0,0 +1,28 @@
[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.)
# automountmap_del
Delete an automount map.
### Arguments
|Name|Type|Required
|-|-|-
|automountlocationcn|:ref:`Str<Str>`|True
|automountmapname|:ref:`IA5Str<IA5Str>`|True
### Options
* continue : :ref:`Flag<Flag>` **(Required)**
* Default: False
* version : :ref:`Str<Str>`
### Output
|Name|Type
|-|-
|result|Output
|summary|Output
|value|ListOfPrimaryKeys
[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end)
### Semantics
### Notes
### Version differences

View File

@ -0,0 +1,37 @@
[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.)
# automountmap_find
Search for an automount map.
### Arguments
|Name|Type|Required
|-|-|-
|automountlocationcn|:ref:`Str<Str>`|True
|criteria|:ref:`Str<Str>`|False
### Options
* all : :ref:`Flag<Flag>` **(Required)**
* Default: False
* raw : :ref:`Flag<Flag>` **(Required)**
* Default: False
* automountmapname : :ref:`IA5Str<IA5Str>`
* description : :ref:`Str<Str>`
* timelimit : :ref:`Int<Int>`
* sizelimit : :ref:`Int<Int>`
* version : :ref:`Str<Str>`
* pkey_only : :ref:`Flag<Flag>`
* Default: False
### Output
|Name|Type
|-|-
|count|Output
|result|ListOfEntries
|summary|Output
|truncated|Output
[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end)
### Semantics
### Notes
### Version differences

View File

@ -0,0 +1,36 @@
[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.)
# automountmap_mod
Modify an automount map.
### Arguments
|Name|Type|Required
|-|-|-
|automountlocationcn|:ref:`Str<Str>`|True
|automountmapname|:ref:`IA5Str<IA5Str>`|True
### Options
* rights : :ref:`Flag<Flag>` **(Required)**
* Default: False
* all : :ref:`Flag<Flag>` **(Required)**
* Default: False
* raw : :ref:`Flag<Flag>` **(Required)**
* Default: False
* description : :ref:`Str<Str>`
* setattr : :ref:`Str<Str>`
* addattr : :ref:`Str<Str>`
* delattr : :ref:`Str<Str>`
* 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

Some files were not shown because too many files have changed in this diff Show More