diff --git a/doc/api/A6Record.md b/doc/api/A6Record.md new file mode 100644 index 000000000..e95c9fbcb --- /dev/null +++ b/doc/api/A6Record.md @@ -0,0 +1,3 @@ +.. _A6Record: + +# A6Record \ No newline at end of file diff --git a/doc/api/AAAARecord.md b/doc/api/AAAARecord.md new file mode 100644 index 000000000..09a9ed546 --- /dev/null +++ b/doc/api/AAAARecord.md @@ -0,0 +1,3 @@ +.. _AAAARecord: + +# AAAARecord \ No newline at end of file diff --git a/doc/api/AFSDBRecord.md b/doc/api/AFSDBRecord.md new file mode 100644 index 000000000..fde8ec158 --- /dev/null +++ b/doc/api/AFSDBRecord.md @@ -0,0 +1,3 @@ +.. _AFSDBRecord: + +# AFSDBRecord \ No newline at end of file diff --git a/doc/api/APLRecord.md b/doc/api/APLRecord.md new file mode 100644 index 000000000..5e545e7b1 --- /dev/null +++ b/doc/api/APLRecord.md @@ -0,0 +1,3 @@ +.. _APLRecord: + +# APLRecord \ No newline at end of file diff --git a/doc/api/ARecord.md b/doc/api/ARecord.md new file mode 100644 index 000000000..de130ac41 --- /dev/null +++ b/doc/api/ARecord.md @@ -0,0 +1,3 @@ +.. _ARecord: + +# ARecord \ No newline at end of file diff --git a/doc/api/AccessTime.md b/doc/api/AccessTime.md new file mode 100644 index 000000000..57c4739ad --- /dev/null +++ b/doc/api/AccessTime.md @@ -0,0 +1,3 @@ +.. _AccessTime: + +# AccessTime \ No newline at end of file diff --git a/doc/api/Any.md b/doc/api/Any.md new file mode 100644 index 000000000..c93d392ad --- /dev/null +++ b/doc/api/Any.md @@ -0,0 +1,3 @@ +.. _Any: + +# Any \ No newline at end of file diff --git a/doc/api/BinaryFile.md b/doc/api/BinaryFile.md new file mode 100644 index 000000000..8df897010 --- /dev/null +++ b/doc/api/BinaryFile.md @@ -0,0 +1,3 @@ +.. _BinaryFile: + +# BinaryFile \ No newline at end of file diff --git a/doc/api/Bool.md b/doc/api/Bool.md new file mode 100644 index 000000000..2fcdb1c58 --- /dev/null +++ b/doc/api/Bool.md @@ -0,0 +1,3 @@ +.. _Bool: + +# Bool \ No newline at end of file diff --git a/doc/api/Bytes.md b/doc/api/Bytes.md new file mode 100644 index 000000000..7bd08a55c --- /dev/null +++ b/doc/api/Bytes.md @@ -0,0 +1,3 @@ +.. _Bytes: + +# Bytes \ No newline at end of file diff --git a/doc/api/BytesEnum.md b/doc/api/BytesEnum.md new file mode 100644 index 000000000..fed9cb39c --- /dev/null +++ b/doc/api/BytesEnum.md @@ -0,0 +1,3 @@ +.. _BytesEnum: + +# BytesEnum \ No newline at end of file diff --git a/doc/api/CERTRecord.md b/doc/api/CERTRecord.md new file mode 100644 index 000000000..73dbbcd4b --- /dev/null +++ b/doc/api/CERTRecord.md @@ -0,0 +1,3 @@ +.. _CERTRecord: + +# CERTRecord \ No newline at end of file diff --git a/doc/api/CNAMERecord.md b/doc/api/CNAMERecord.md new file mode 100644 index 000000000..a4300de08 --- /dev/null +++ b/doc/api/CNAMERecord.md @@ -0,0 +1,3 @@ +.. _CNAMERecord: + +# CNAMERecord \ No newline at end of file diff --git a/doc/api/Certificate.md b/doc/api/Certificate.md new file mode 100644 index 000000000..825fbec33 --- /dev/null +++ b/doc/api/Certificate.md @@ -0,0 +1,3 @@ +.. _Certificate: + +# Certificate \ No newline at end of file diff --git a/doc/api/CertificateSigningRequest.md b/doc/api/CertificateSigningRequest.md new file mode 100644 index 000000000..193c09f5f --- /dev/null +++ b/doc/api/CertificateSigningRequest.md @@ -0,0 +1,3 @@ +.. _CertificateSigningRequest: + +# CertificateSigningRequest \ No newline at end of file diff --git a/doc/api/DHCIDRecord.md b/doc/api/DHCIDRecord.md new file mode 100644 index 000000000..0bda2460f --- /dev/null +++ b/doc/api/DHCIDRecord.md @@ -0,0 +1,3 @@ +.. _DHCIDRecord: + +# DHCIDRecord \ No newline at end of file diff --git a/doc/api/DLVRecord.md b/doc/api/DLVRecord.md new file mode 100644 index 000000000..7620c2aca --- /dev/null +++ b/doc/api/DLVRecord.md @@ -0,0 +1,3 @@ +.. _DLVRecord: + +# DLVRecord \ No newline at end of file diff --git a/doc/api/DNAMERecord.md b/doc/api/DNAMERecord.md new file mode 100644 index 000000000..9f40b11ae --- /dev/null +++ b/doc/api/DNAMERecord.md @@ -0,0 +1,3 @@ +.. _DNAMERecord: + +# DNAMERecord \ No newline at end of file diff --git a/doc/api/DNOrURL.md b/doc/api/DNOrURL.md new file mode 100644 index 000000000..9e65d06f5 --- /dev/null +++ b/doc/api/DNOrURL.md @@ -0,0 +1,3 @@ +.. _DNOrURL: + +# DNOrURL \ No newline at end of file diff --git a/doc/api/DNParam.md b/doc/api/DNParam.md new file mode 100644 index 000000000..6da9c9aec --- /dev/null +++ b/doc/api/DNParam.md @@ -0,0 +1,3 @@ +.. _DNParam: + +# DNParam \ No newline at end of file diff --git a/doc/api/DNSNameParam.md b/doc/api/DNSNameParam.md new file mode 100644 index 000000000..0ec7988c7 --- /dev/null +++ b/doc/api/DNSNameParam.md @@ -0,0 +1,3 @@ +.. _DNSNameParam: + +# DNSNameParam \ No newline at end of file diff --git a/doc/api/DNSRecord.md b/doc/api/DNSRecord.md new file mode 100644 index 000000000..13cf1a912 --- /dev/null +++ b/doc/api/DNSRecord.md @@ -0,0 +1,3 @@ +.. _DNSRecord: + +# DNSRecord \ No newline at end of file diff --git a/doc/api/DSRecord.md b/doc/api/DSRecord.md new file mode 100644 index 000000000..060aa7881 --- /dev/null +++ b/doc/api/DSRecord.md @@ -0,0 +1,3 @@ +.. _DSRecord: + +# DSRecord \ No newline at end of file diff --git a/doc/api/Data.md b/doc/api/Data.md new file mode 100644 index 000000000..68cbd7f69 --- /dev/null +++ b/doc/api/Data.md @@ -0,0 +1,3 @@ +.. _Data: + +# Data \ No newline at end of file diff --git a/doc/api/DateTime.md b/doc/api/DateTime.md new file mode 100644 index 000000000..97f315281 --- /dev/null +++ b/doc/api/DateTime.md @@ -0,0 +1,3 @@ +.. _DateTime: + +# DateTime \ No newline at end of file diff --git a/doc/api/Decimal.md b/doc/api/Decimal.md new file mode 100644 index 000000000..cd0f035f5 --- /dev/null +++ b/doc/api/Decimal.md @@ -0,0 +1,3 @@ +.. _Decimal: + +# Decimal \ No newline at end of file diff --git a/doc/api/Dict.md b/doc/api/Dict.md new file mode 100644 index 000000000..7187604be --- /dev/null +++ b/doc/api/Dict.md @@ -0,0 +1,3 @@ +.. _Dict: + +# Dict \ No newline at end of file diff --git a/doc/api/Enum.md b/doc/api/Enum.md new file mode 100644 index 000000000..6d6ffb089 --- /dev/null +++ b/doc/api/Enum.md @@ -0,0 +1,3 @@ +.. _Enum: + +# Enum \ No newline at end of file diff --git a/doc/api/File.md b/doc/api/File.md new file mode 100644 index 000000000..c00f3f673 --- /dev/null +++ b/doc/api/File.md @@ -0,0 +1,3 @@ +.. _File: + +# File \ No newline at end of file diff --git a/doc/api/Flag.md b/doc/api/Flag.md new file mode 100644 index 000000000..e64836809 --- /dev/null +++ b/doc/api/Flag.md @@ -0,0 +1,3 @@ +.. _Flag: + +# Flag \ No newline at end of file diff --git a/doc/api/ForwardRecord.md b/doc/api/ForwardRecord.md new file mode 100644 index 000000000..dd718b037 --- /dev/null +++ b/doc/api/ForwardRecord.md @@ -0,0 +1,3 @@ +.. _ForwardRecord: + +# ForwardRecord \ No newline at end of file diff --git a/doc/api/HINFORecord.md b/doc/api/HINFORecord.md new file mode 100644 index 000000000..d3d518efe --- /dev/null +++ b/doc/api/HINFORecord.md @@ -0,0 +1,3 @@ +.. _HINFORecord: + +# HINFORecord \ No newline at end of file diff --git a/doc/api/HIPRecord.md b/doc/api/HIPRecord.md new file mode 100644 index 000000000..5eae940fe --- /dev/null +++ b/doc/api/HIPRecord.md @@ -0,0 +1,3 @@ +.. _HIPRecord: + +# HIPRecord \ No newline at end of file diff --git a/doc/api/HostPassword.md b/doc/api/HostPassword.md new file mode 100644 index 000000000..3427cfe9d --- /dev/null +++ b/doc/api/HostPassword.md @@ -0,0 +1,3 @@ +.. _HostPassword: + +# HostPassword \ No newline at end of file diff --git a/doc/api/IA5Str.md b/doc/api/IA5Str.md new file mode 100644 index 000000000..a0b02e7ca --- /dev/null +++ b/doc/api/IA5Str.md @@ -0,0 +1,3 @@ +.. _IA5Str: + +# IA5Str \ No newline at end of file diff --git a/doc/api/IPSECKEYRecord.md b/doc/api/IPSECKEYRecord.md new file mode 100644 index 000000000..90361b6a8 --- /dev/null +++ b/doc/api/IPSECKEYRecord.md @@ -0,0 +1,3 @@ +.. _IPSECKEYRecord: + +# IPSECKEYRecord \ No newline at end of file diff --git a/doc/api/Int.md b/doc/api/Int.md new file mode 100644 index 000000000..def4c7317 --- /dev/null +++ b/doc/api/Int.md @@ -0,0 +1,3 @@ +.. _Int: + +# Int \ No newline at end of file diff --git a/doc/api/IntEnum.md b/doc/api/IntEnum.md new file mode 100644 index 000000000..f4a41588d --- /dev/null +++ b/doc/api/IntEnum.md @@ -0,0 +1,3 @@ +.. _IntEnum: + +# IntEnum \ No newline at end of file diff --git a/doc/api/KEYRecord.md b/doc/api/KEYRecord.md new file mode 100644 index 000000000..45a11c5a6 --- /dev/null +++ b/doc/api/KEYRecord.md @@ -0,0 +1,3 @@ +.. _KEYRecord: + +# KEYRecord \ No newline at end of file diff --git a/doc/api/KXRecord.md b/doc/api/KXRecord.md new file mode 100644 index 000000000..637b9236b --- /dev/null +++ b/doc/api/KXRecord.md @@ -0,0 +1,3 @@ +.. _KXRecord: + +# KXRecord \ No newline at end of file diff --git a/doc/api/LOCRecord.md b/doc/api/LOCRecord.md new file mode 100644 index 000000000..aa4622788 --- /dev/null +++ b/doc/api/LOCRecord.md @@ -0,0 +1,3 @@ +.. _LOCRecord: + +# LOCRecord \ No newline at end of file diff --git a/doc/api/MDRecord.md b/doc/api/MDRecord.md new file mode 100644 index 000000000..62e3b64db --- /dev/null +++ b/doc/api/MDRecord.md @@ -0,0 +1,3 @@ +.. _MDRecord: + +# MDRecord \ No newline at end of file diff --git a/doc/api/MINFORecord.md b/doc/api/MINFORecord.md new file mode 100644 index 000000000..f36b1f28b --- /dev/null +++ b/doc/api/MINFORecord.md @@ -0,0 +1,3 @@ +.. _MINFORecord: + +# MINFORecord \ No newline at end of file diff --git a/doc/api/MXRecord.md b/doc/api/MXRecord.md new file mode 100644 index 000000000..b582103f5 --- /dev/null +++ b/doc/api/MXRecord.md @@ -0,0 +1,3 @@ +.. _MXRecord: + +# MXRecord \ No newline at end of file diff --git a/doc/api/NAPTRRecord.md b/doc/api/NAPTRRecord.md new file mode 100644 index 000000000..f2e1bf488 --- /dev/null +++ b/doc/api/NAPTRRecord.md @@ -0,0 +1,3 @@ +.. _NAPTRRecord: + +# NAPTRRecord \ No newline at end of file diff --git a/doc/api/NSECRecord.md b/doc/api/NSECRecord.md new file mode 100644 index 000000000..654875eba --- /dev/null +++ b/doc/api/NSECRecord.md @@ -0,0 +1,3 @@ +.. _NSECRecord: + +# NSECRecord \ No newline at end of file diff --git a/doc/api/NSRecord.md b/doc/api/NSRecord.md new file mode 100644 index 000000000..f9b485005 --- /dev/null +++ b/doc/api/NSRecord.md @@ -0,0 +1,3 @@ +.. _NSRecord: + +# NSRecord \ No newline at end of file diff --git a/doc/api/NXTRecord.md b/doc/api/NXTRecord.md new file mode 100644 index 000000000..fd6605d0f --- /dev/null +++ b/doc/api/NXTRecord.md @@ -0,0 +1,3 @@ +.. _NXTRecord: + +# NXTRecord \ No newline at end of file diff --git a/doc/api/Number.md b/doc/api/Number.md new file mode 100644 index 000000000..3b5ba999b --- /dev/null +++ b/doc/api/Number.md @@ -0,0 +1,3 @@ +.. _Number: + +# Number \ No newline at end of file diff --git a/doc/api/OTPTokenKey.md b/doc/api/OTPTokenKey.md new file mode 100644 index 000000000..b1758f26d --- /dev/null +++ b/doc/api/OTPTokenKey.md @@ -0,0 +1,3 @@ +.. _OTPTokenKey: + +# OTPTokenKey \ No newline at end of file diff --git a/doc/api/PTRRecord.md b/doc/api/PTRRecord.md new file mode 100644 index 000000000..e45231502 --- /dev/null +++ b/doc/api/PTRRecord.md @@ -0,0 +1,3 @@ +.. _PTRRecord: + +# PTRRecord \ No newline at end of file diff --git a/doc/api/Password.md b/doc/api/Password.md new file mode 100644 index 000000000..662adc474 --- /dev/null +++ b/doc/api/Password.md @@ -0,0 +1,3 @@ +.. _Password: + +# Password \ No newline at end of file diff --git a/doc/api/Principal.md b/doc/api/Principal.md new file mode 100644 index 000000000..429b6f200 --- /dev/null +++ b/doc/api/Principal.md @@ -0,0 +1,3 @@ +.. _Principal: + +# Principal \ No newline at end of file diff --git a/doc/api/RPRecord.md b/doc/api/RPRecord.md new file mode 100644 index 000000000..d3a512520 --- /dev/null +++ b/doc/api/RPRecord.md @@ -0,0 +1,3 @@ +.. _RPRecord: + +# RPRecord \ No newline at end of file diff --git a/doc/api/RRSIGRecord.md b/doc/api/RRSIGRecord.md new file mode 100644 index 000000000..961ed6912 --- /dev/null +++ b/doc/api/RRSIGRecord.md @@ -0,0 +1,3 @@ +.. _RRSIGRecord: + +# RRSIGRecord \ No newline at end of file diff --git a/doc/api/SIGRecord.md b/doc/api/SIGRecord.md new file mode 100644 index 000000000..b554c34be --- /dev/null +++ b/doc/api/SIGRecord.md @@ -0,0 +1,3 @@ +.. _SIGRecord: + +# SIGRecord \ No newline at end of file diff --git a/doc/api/SPFRecord.md b/doc/api/SPFRecord.md new file mode 100644 index 000000000..5dc66501d --- /dev/null +++ b/doc/api/SPFRecord.md @@ -0,0 +1,3 @@ +.. _SPFRecord: + +# SPFRecord \ No newline at end of file diff --git a/doc/api/SRVRecord.md b/doc/api/SRVRecord.md new file mode 100644 index 000000000..9c969d50f --- /dev/null +++ b/doc/api/SRVRecord.md @@ -0,0 +1,3 @@ +.. _SRVRecord: + +# SRVRecord \ No newline at end of file diff --git a/doc/api/SSHFPRecord.md b/doc/api/SSHFPRecord.md new file mode 100644 index 000000000..3705f063c --- /dev/null +++ b/doc/api/SSHFPRecord.md @@ -0,0 +1,3 @@ +.. _SSHFPRecord: + +# SSHFPRecord \ No newline at end of file diff --git a/doc/api/SerialNumber.md b/doc/api/SerialNumber.md new file mode 100644 index 000000000..e7ee4a0bb --- /dev/null +++ b/doc/api/SerialNumber.md @@ -0,0 +1,3 @@ +.. _SerialNumber: + +# SerialNumber \ No newline at end of file diff --git a/doc/api/Str.md b/doc/api/Str.md new file mode 100644 index 000000000..917f96d9f --- /dev/null +++ b/doc/api/Str.md @@ -0,0 +1,3 @@ +.. _Str: + +# Str \ No newline at end of file diff --git a/doc/api/StrEnum.md b/doc/api/StrEnum.md new file mode 100644 index 000000000..7a2651485 --- /dev/null +++ b/doc/api/StrEnum.md @@ -0,0 +1,3 @@ +.. _StrEnum: + +# StrEnum \ No newline at end of file diff --git a/doc/api/TLSARecord.md b/doc/api/TLSARecord.md new file mode 100644 index 000000000..6ac192875 --- /dev/null +++ b/doc/api/TLSARecord.md @@ -0,0 +1,3 @@ +.. _TLSARecord: + +# TLSARecord \ No newline at end of file diff --git a/doc/api/TXTRecord.md b/doc/api/TXTRecord.md new file mode 100644 index 000000000..bc577d862 --- /dev/null +++ b/doc/api/TXTRecord.md @@ -0,0 +1,3 @@ +.. _TXTRecord: + +# TXTRecord \ No newline at end of file diff --git a/doc/api/URIRecord.md b/doc/api/URIRecord.md new file mode 100644 index 000000000..c8a9372b8 --- /dev/null +++ b/doc/api/URIRecord.md @@ -0,0 +1,3 @@ +.. _URIRecord: + +# URIRecord \ No newline at end of file diff --git a/doc/api/UnsupportedDNSRecord.md b/doc/api/UnsupportedDNSRecord.md new file mode 100644 index 000000000..6b45cec62 --- /dev/null +++ b/doc/api/UnsupportedDNSRecord.md @@ -0,0 +1,3 @@ +.. _UnsupportedDNSRecord: + +# UnsupportedDNSRecord \ No newline at end of file diff --git a/doc/api/aci_add.md b/doc/api/aci_add.md new file mode 100644 index 000000000..deaef93f5 --- /dev/null +++ b/doc/api/aci_add.md @@ -0,0 +1,45 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# aci_add +Create new ACI. + +### Arguments +|Name|Type|Required +|-|-|- +|aciname|:ref:`Str`|True + +### Options +* permissions : :ref:`Str` **(Required)** +* aciprefix : :ref:`StrEnum` **(Required)** + * Values: ('permission', 'delegation', 'selfservice', 'none') +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* permission : :ref:`Str` +* group : :ref:`Str` +* attrs : :ref:`Str` +* type : :ref:`StrEnum` + * Values: ('user', 'group', 'host', 'service', 'hostgroup', 'netgroup', 'dnsrecord') +* memberof : :ref:`Str` +* filter : :ref:`Str` +* subtree : :ref:`Str` +* targetgroup : :ref:`Str` +* selfaci : :ref:`Flag` + * Default: False +* test : :ref:`Flag` + * Default: False +* version : :ref:`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 \ No newline at end of file diff --git a/doc/api/aci_del.md b/doc/api/aci_del.md new file mode 100644 index 000000000..68affab6a --- /dev/null +++ b/doc/api/aci_del.md @@ -0,0 +1,27 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# aci_del +Delete ACI. + +### Arguments +|Name|Type|Required +|-|-|- +|aciname|:ref:`Str`|True + +### Options +* aciprefix : :ref:`StrEnum` **(Required)** + * Values: ('permission', 'delegation', 'selfservice', 'none') +* version : :ref:`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 \ No newline at end of file diff --git a/doc/api/aci_find.md b/doc/api/aci_find.md new file mode 100644 index 000000000..d0e40a2b0 --- /dev/null +++ b/doc/api/aci_find.md @@ -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`|False + +### Options +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* aciname : :ref:`Str` +* permission : :ref:`Str` +* group : :ref:`Str` +* permissions : :ref:`Str` +* attrs : :ref:`Str` +* type : :ref:`StrEnum` + * Values: ('user', 'group', 'host', 'service', 'hostgroup', 'netgroup', 'dnsrecord') +* memberof : :ref:`Str` +* filter : :ref:`Str` +* subtree : :ref:`Str` +* targetgroup : :ref:`Str` +* selfaci : :ref:`Bool` + * Default: False +* aciprefix : :ref:`StrEnum` + * Values: ('permission', 'delegation', 'selfservice', 'none') +* pkey_only : :ref:`Flag` + * Default: False +* version : :ref:`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 \ No newline at end of file diff --git a/doc/api/aci_mod.md b/doc/api/aci_mod.md new file mode 100644 index 000000000..85c3ad6f2 --- /dev/null +++ b/doc/api/aci_mod.md @@ -0,0 +1,43 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# aci_mod +Modify ACI. + +### Arguments +|Name|Type|Required +|-|-|- +|aciname|:ref:`Str`|True + +### Options +* aciprefix : :ref:`StrEnum` **(Required)** + * Values: ('permission', 'delegation', 'selfservice', 'none') +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* permission : :ref:`Str` +* group : :ref:`Str` +* permissions : :ref:`Str` +* attrs : :ref:`Str` +* type : :ref:`StrEnum` + * Values: ('user', 'group', 'host', 'service', 'hostgroup', 'netgroup', 'dnsrecord') +* memberof : :ref:`Str` +* filter : :ref:`Str` +* subtree : :ref:`Str` +* targetgroup : :ref:`Str` +* selfaci : :ref:`Flag` + * Default: False +* version : :ref:`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 \ No newline at end of file diff --git a/doc/api/aci_rename.md b/doc/api/aci_rename.md new file mode 100644 index 000000000..fc6cef5b0 --- /dev/null +++ b/doc/api/aci_rename.md @@ -0,0 +1,44 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# aci_rename +Rename an ACI. + +### Arguments +|Name|Type|Required +|-|-|- +|aciname|:ref:`Str`|True + +### Options +* aciprefix : :ref:`StrEnum` **(Required)** + * Values: ('permission', 'delegation', 'selfservice', 'none') +* newname : :ref:`Str` **(Required)** +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* permission : :ref:`Str` +* group : :ref:`Str` +* permissions : :ref:`Str` +* attrs : :ref:`Str` +* type : :ref:`StrEnum` + * Values: ('user', 'group', 'host', 'service', 'hostgroup', 'netgroup', 'dnsrecord') +* memberof : :ref:`Str` +* filter : :ref:`Str` +* subtree : :ref:`Str` +* targetgroup : :ref:`Str` +* selfaci : :ref:`Flag` + * Default: False +* version : :ref:`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 \ No newline at end of file diff --git a/doc/api/aci_show.md b/doc/api/aci_show.md new file mode 100644 index 000000000..9cef83404 --- /dev/null +++ b/doc/api/aci_show.md @@ -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`|True + +### Options +* aciprefix : :ref:`StrEnum` **(Required)** + * Values: ('permission', 'delegation', 'selfservice', 'none') +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* location : :ref:`DNParam` +* version : :ref:`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 \ No newline at end of file diff --git a/doc/api/adtrust_is_enabled.md b/doc/api/adtrust_is_enabled.md new file mode 100644 index 000000000..f99d8eb2b --- /dev/null +++ b/doc/api/adtrust_is_enabled.md @@ -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` + +### Output +|Name|Type +|-|- +|result|Output + +[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end) +### Semantics + +### Notes + +### Version differences \ No newline at end of file diff --git a/doc/api/automember_add.md b/doc/api/automember_add.md new file mode 100644 index 000000000..6c0232ec0 --- /dev/null +++ b/doc/api/automember_add.md @@ -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`|True + +### Options +* type : :ref:`StrEnum` **(Required)** + * Values: ('group', 'hostgroup') +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* description : :ref:`Str` +* setattr : :ref:`Str` +* addattr : :ref:`Str` +* version : :ref:`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 \ No newline at end of file diff --git a/doc/api/automember_add_condition.md b/doc/api/automember_add_condition.md new file mode 100644 index 000000000..5f97e18e7 --- /dev/null +++ b/doc/api/automember_add_condition.md @@ -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`|True + +### Options +* key : :ref:`Str` **(Required)** +* type : :ref:`StrEnum` **(Required)** + * Values: ('group', 'hostgroup') +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* description : :ref:`Str` +* automemberinclusiveregex : :ref:`Str` +* automemberexclusiveregex : :ref:`Str` +* version : :ref:`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 \ No newline at end of file diff --git a/doc/api/automember_default_group_remove.md b/doc/api/automember_default_group_remove.md new file mode 100644 index 000000000..8a42351b3 --- /dev/null +++ b/doc/api/automember_default_group_remove.md @@ -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` **(Required)** + * Values: ('group', 'hostgroup') +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* version : :ref:`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 \ No newline at end of file diff --git a/doc/api/automember_default_group_set.md b/doc/api/automember_default_group_set.md new file mode 100644 index 000000000..cedf8a110 --- /dev/null +++ b/doc/api/automember_default_group_set.md @@ -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` **(Required)** +* type : :ref:`StrEnum` **(Required)** + * Values: ('group', 'hostgroup') +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* version : :ref:`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 \ No newline at end of file diff --git a/doc/api/automember_default_group_show.md b/doc/api/automember_default_group_show.md new file mode 100644 index 000000000..c2b80f155 --- /dev/null +++ b/doc/api/automember_default_group_show.md @@ -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` **(Required)** + * Values: ('group', 'hostgroup') +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* version : :ref:`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 \ No newline at end of file diff --git a/doc/api/automember_del.md b/doc/api/automember_del.md new file mode 100644 index 000000000..491498ee3 --- /dev/null +++ b/doc/api/automember_del.md @@ -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`|True + +### Options +* type : :ref:`StrEnum` **(Required)** + * Values: ('group', 'hostgroup') +* version : :ref:`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 \ No newline at end of file diff --git a/doc/api/automember_find.md b/doc/api/automember_find.md new file mode 100644 index 000000000..256b331b3 --- /dev/null +++ b/doc/api/automember_find.md @@ -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`|False + +### Options +* type : :ref:`StrEnum` **(Required)** + * Values: ('group', 'hostgroup') +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* description : :ref:`Str` +* version : :ref:`Str` +* pkey_only : :ref:`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 \ No newline at end of file diff --git a/doc/api/automember_find_orphans.md b/doc/api/automember_find_orphans.md new file mode 100644 index 000000000..c99d458fa --- /dev/null +++ b/doc/api/automember_find_orphans.md @@ -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`|False + +### Options +* type : :ref:`StrEnum` **(Required)** + * Values: ('group', 'hostgroup') +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* description : :ref:`Str` +* remove : :ref:`Flag` + * Default: False +* version : :ref:`Str` +* pkey_only : :ref:`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 \ No newline at end of file diff --git a/doc/api/automember_mod.md b/doc/api/automember_mod.md new file mode 100644 index 000000000..45e9bf9eb --- /dev/null +++ b/doc/api/automember_mod.md @@ -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`|True + +### Options +* rights : :ref:`Flag` **(Required)** + * Default: False +* type : :ref:`StrEnum` **(Required)** + * Values: ('group', 'hostgroup') +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* description : :ref:`Str` +* setattr : :ref:`Str` +* addattr : :ref:`Str` +* delattr : :ref:`Str` +* version : :ref:`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 \ No newline at end of file diff --git a/doc/api/automember_rebuild.md b/doc/api/automember_rebuild.md new file mode 100644 index 000000000..2db83f711 --- /dev/null +++ b/doc/api/automember_rebuild.md @@ -0,0 +1,33 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# automember_rebuild +Rebuild auto membership. + +### Arguments +No arguments. + +### Options +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* type : :ref:`StrEnum` + * Values: ('group', 'hostgroup') +* users : :ref:`Str` +* hosts : :ref:`Str` +* no_wait : :ref:`Flag` + * Default: False +* version : :ref:`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 \ No newline at end of file diff --git a/doc/api/automember_remove_condition.md b/doc/api/automember_remove_condition.md new file mode 100644 index 000000000..71495431b --- /dev/null +++ b/doc/api/automember_remove_condition.md @@ -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`|True + +### Options +* key : :ref:`Str` **(Required)** +* type : :ref:`StrEnum` **(Required)** + * Values: ('group', 'hostgroup') +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* description : :ref:`Str` +* automemberinclusiveregex : :ref:`Str` +* automemberexclusiveregex : :ref:`Str` +* version : :ref:`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 \ No newline at end of file diff --git a/doc/api/automember_show.md b/doc/api/automember_show.md new file mode 100644 index 000000000..00555a1d3 --- /dev/null +++ b/doc/api/automember_show.md @@ -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`|True + +### Options +* type : :ref:`StrEnum` **(Required)** + * Values: ('group', 'hostgroup') +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* version : :ref:`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 \ No newline at end of file diff --git a/doc/api/automountkey_add.md b/doc/api/automountkey_add.md new file mode 100644 index 000000000..5046b7378 --- /dev/null +++ b/doc/api/automountkey_add.md @@ -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`|True +|automountmapautomountmapname|:ref:`IA5Str`|True + +### Options +* automountkey : :ref:`IA5Str` **(Required)** +* automountinformation : :ref:`IA5Str` **(Required)** +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* setattr : :ref:`Str` +* addattr : :ref:`Str` +* version : :ref:`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 \ No newline at end of file diff --git a/doc/api/automountkey_del.md b/doc/api/automountkey_del.md new file mode 100644 index 000000000..67f86ce34 --- /dev/null +++ b/doc/api/automountkey_del.md @@ -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`|True +|automountmapautomountmapname|:ref:`IA5Str`|True + +### Options +* continue : :ref:`Flag` **(Required)** + * Default: False +* automountkey : :ref:`IA5Str` **(Required)** +* automountinformation : :ref:`IA5Str` +* version : :ref:`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 \ No newline at end of file diff --git a/doc/api/automountkey_find.md b/doc/api/automountkey_find.md new file mode 100644 index 000000000..079076346 --- /dev/null +++ b/doc/api/automountkey_find.md @@ -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`|True +|automountmapautomountmapname|:ref:`IA5Str`|True +|criteria|:ref:`Str`|False + +### Options +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* automountkey : :ref:`IA5Str` +* automountinformation : :ref:`IA5Str` +* timelimit : :ref:`Int` +* sizelimit : :ref:`Int` +* version : :ref:`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 \ No newline at end of file diff --git a/doc/api/automountkey_mod.md b/doc/api/automountkey_mod.md new file mode 100644 index 000000000..ab39a19a9 --- /dev/null +++ b/doc/api/automountkey_mod.md @@ -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`|True +|automountmapautomountmapname|:ref:`IA5Str`|True + +### Options +* automountkey : :ref:`IA5Str` **(Required)** +* rights : :ref:`Flag` **(Required)** + * Default: False +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* automountinformation : :ref:`IA5Str` +* setattr : :ref:`Str` +* addattr : :ref:`Str` +* delattr : :ref:`Str` +* newautomountinformation : :ref:`IA5Str` +* version : :ref:`Str` +* rename : :ref:`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 \ No newline at end of file diff --git a/doc/api/automountkey_show.md b/doc/api/automountkey_show.md new file mode 100644 index 000000000..a943c946d --- /dev/null +++ b/doc/api/automountkey_show.md @@ -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`|True +|automountmapautomountmapname|:ref:`IA5Str`|True + +### Options +* rights : :ref:`Flag` **(Required)** + * Default: False +* automountkey : :ref:`IA5Str` **(Required)** +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* automountinformation : :ref:`IA5Str` +* version : :ref:`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 \ No newline at end of file diff --git a/doc/api/automountlocation_add.md b/doc/api/automountlocation_add.md new file mode 100644 index 000000000..1e5663649 --- /dev/null +++ b/doc/api/automountlocation_add.md @@ -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`|True + +### Options +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* setattr : :ref:`Str` +* addattr : :ref:`Str` +* version : :ref:`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 \ No newline at end of file diff --git a/doc/api/automountlocation_del.md b/doc/api/automountlocation_del.md new file mode 100644 index 000000000..c5c06f75c --- /dev/null +++ b/doc/api/automountlocation_del.md @@ -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`|True + +### Options +* continue : :ref:`Flag` **(Required)** + * Default: False +* version : :ref:`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 \ No newline at end of file diff --git a/doc/api/automountlocation_find.md b/doc/api/automountlocation_find.md new file mode 100644 index 000000000..dc127e680 --- /dev/null +++ b/doc/api/automountlocation_find.md @@ -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`|False + +### Options +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* cn : :ref:`Str` +* timelimit : :ref:`Int` +* sizelimit : :ref:`Int` +* version : :ref:`Str` +* pkey_only : :ref:`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 \ No newline at end of file diff --git a/doc/api/automountlocation_show.md b/doc/api/automountlocation_show.md new file mode 100644 index 000000000..feceaf919 --- /dev/null +++ b/doc/api/automountlocation_show.md @@ -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`|True + +### Options +* rights : :ref:`Flag` **(Required)** + * Default: False +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* version : :ref:`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 \ No newline at end of file diff --git a/doc/api/automountlocation_tofiles.md b/doc/api/automountlocation_tofiles.md new file mode 100644 index 000000000..956aa6b89 --- /dev/null +++ b/doc/api/automountlocation_tofiles.md @@ -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`|True + +### Options +* version : :ref:`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 \ No newline at end of file diff --git a/doc/api/automountmap_add.md b/doc/api/automountmap_add.md new file mode 100644 index 000000000..d235c5e88 --- /dev/null +++ b/doc/api/automountmap_add.md @@ -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`|True +|automountmapname|:ref:`IA5Str`|True + +### Options +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* description : :ref:`Str` +* setattr : :ref:`Str` +* addattr : :ref:`Str` +* version : :ref:`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 \ No newline at end of file diff --git a/doc/api/automountmap_add_indirect.md b/doc/api/automountmap_add_indirect.md new file mode 100644 index 000000000..2a069fcaa --- /dev/null +++ b/doc/api/automountmap_add_indirect.md @@ -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`|True +|automountmapname|:ref:`IA5Str`|True + +### Options +* key : :ref:`Str` **(Required)** +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* description : :ref:`Str` +* setattr : :ref:`Str` +* addattr : :ref:`Str` +* parentmap : :ref:`Str` + * Default: auto.master +* version : :ref:`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 \ No newline at end of file diff --git a/doc/api/automountmap_del.md b/doc/api/automountmap_del.md new file mode 100644 index 000000000..e1e24fe5c --- /dev/null +++ b/doc/api/automountmap_del.md @@ -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`|True +|automountmapname|:ref:`IA5Str`|True + +### Options +* continue : :ref:`Flag` **(Required)** + * Default: False +* version : :ref:`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 \ No newline at end of file diff --git a/doc/api/automountmap_find.md b/doc/api/automountmap_find.md new file mode 100644 index 000000000..3abe5979b --- /dev/null +++ b/doc/api/automountmap_find.md @@ -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`|True +|criteria|:ref:`Str`|False + +### Options +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* automountmapname : :ref:`IA5Str` +* description : :ref:`Str` +* timelimit : :ref:`Int` +* sizelimit : :ref:`Int` +* version : :ref:`Str` +* pkey_only : :ref:`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 \ No newline at end of file diff --git a/doc/api/automountmap_mod.md b/doc/api/automountmap_mod.md new file mode 100644 index 000000000..f6cd40b6c --- /dev/null +++ b/doc/api/automountmap_mod.md @@ -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`|True +|automountmapname|:ref:`IA5Str`|True + +### Options +* rights : :ref:`Flag` **(Required)** + * Default: False +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* description : :ref:`Str` +* setattr : :ref:`Str` +* addattr : :ref:`Str` +* delattr : :ref:`Str` +* version : :ref:`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 \ No newline at end of file diff --git a/doc/api/automountmap_show.md b/doc/api/automountmap_show.md new file mode 100644 index 000000000..016f6ee04 --- /dev/null +++ b/doc/api/automountmap_show.md @@ -0,0 +1,32 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# automountmap_show +Display an automount map. + +### Arguments +|Name|Type|Required +|-|-|- +|automountlocationcn|:ref:`Str`|True +|automountmapname|:ref:`IA5Str`|True + +### Options +* rights : :ref:`Flag` **(Required)** + * Default: False +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* version : :ref:`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 \ No newline at end of file diff --git a/doc/api/batch.md b/doc/api/batch.md new file mode 100644 index 000000000..582ef57b4 --- /dev/null +++ b/doc/api/batch.md @@ -0,0 +1,24 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# batch +Make multiple ipa calls via one remote procedure call + +### Arguments +|Name|Type|Required +|-|-|- +|methods|:ref:`Dict`|False + +### Options +* version : :ref:`Str` + +### Output +|Name|Type +|-|- +|count|Output +|results|Output + +[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end) +### Semantics + +### Notes + +### Version differences \ No newline at end of file diff --git a/doc/api/ca_add.md b/doc/api/ca_add.md new file mode 100644 index 000000000..4b16cd91f --- /dev/null +++ b/doc/api/ca_add.md @@ -0,0 +1,35 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# ca_add +Create a CA. + +### Arguments +|Name|Type|Required +|-|-|- +|cn|:ref:`Str`|True + +### Options +* ipacasubjectdn : :ref:`DNParam` **(Required)** +* chain : :ref:`Flag` **(Required)** + * Default: False +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* description : :ref:`Str` +* setattr : :ref:`Str` +* addattr : :ref:`Str` +* version : :ref:`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 \ No newline at end of file diff --git a/doc/api/ca_del.md b/doc/api/ca_del.md new file mode 100644 index 000000000..3b5b1cd58 --- /dev/null +++ b/doc/api/ca_del.md @@ -0,0 +1,27 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# ca_del +Delete a CA (must be disabled first). + +### Arguments +|Name|Type|Required +|-|-|- +|cn|:ref:`Str`|True + +### Options +* continue : :ref:`Flag` **(Required)** + * Default: False +* version : :ref:`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 \ No newline at end of file diff --git a/doc/api/ca_disable.md b/doc/api/ca_disable.md new file mode 100644 index 000000000..b641e9177 --- /dev/null +++ b/doc/api/ca_disable.md @@ -0,0 +1,25 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# ca_disable +Disable a CA. + +### Arguments +|Name|Type|Required +|-|-|- +|cn|:ref:`Str`|True + +### Options +* version : :ref:`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 \ No newline at end of file diff --git a/doc/api/ca_enable.md b/doc/api/ca_enable.md new file mode 100644 index 000000000..3f3496384 --- /dev/null +++ b/doc/api/ca_enable.md @@ -0,0 +1,25 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# ca_enable +Enable a CA. + +### Arguments +|Name|Type|Required +|-|-|- +|cn|:ref:`Str`|True + +### Options +* version : :ref:`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 \ No newline at end of file diff --git a/doc/api/ca_find.md b/doc/api/ca_find.md new file mode 100644 index 000000000..2f6496817 --- /dev/null +++ b/doc/api/ca_find.md @@ -0,0 +1,40 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# ca_find +Search for CAs. + +### Arguments +|Name|Type|Required +|-|-|- +|criteria|:ref:`Str`|False + +### Options +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* cn : :ref:`Str` +* description : :ref:`Str` +* ipacaid : :ref:`Str` +* ipacasubjectdn : :ref:`DNParam` +* ipacaissuerdn : :ref:`DNParam` +* ipacarandomserialnumberversion : :ref:`Int` +* timelimit : :ref:`Int` +* sizelimit : :ref:`Int` +* version : :ref:`Str` +* pkey_only : :ref:`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 \ No newline at end of file diff --git a/doc/api/ca_is_enabled.md b/doc/api/ca_is_enabled.md new file mode 100644 index 000000000..bb6296aa3 --- /dev/null +++ b/doc/api/ca_is_enabled.md @@ -0,0 +1,23 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# ca_is_enabled +Checks if any of the servers has the CA service enabled. + +### Arguments +No arguments. + +### Options +* version : :ref:`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 \ No newline at end of file diff --git a/doc/api/ca_mod.md b/doc/api/ca_mod.md new file mode 100644 index 000000000..a186974f8 --- /dev/null +++ b/doc/api/ca_mod.md @@ -0,0 +1,36 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# ca_mod +Modify CA configuration. + +### Arguments +|Name|Type|Required +|-|-|- +|cn|:ref:`Str`|True + +### Options +* rights : :ref:`Flag` **(Required)** + * Default: False +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* description : :ref:`Str` +* setattr : :ref:`Str` +* addattr : :ref:`Str` +* delattr : :ref:`Str` +* version : :ref:`Str` +* rename : :ref:`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 \ No newline at end of file diff --git a/doc/api/ca_show.md b/doc/api/ca_show.md new file mode 100644 index 000000000..2bd5beebe --- /dev/null +++ b/doc/api/ca_show.md @@ -0,0 +1,33 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# ca_show +Display the properties of a CA. + +### Arguments +|Name|Type|Required +|-|-|- +|cn|:ref:`Str`|True + +### Options +* rights : :ref:`Flag` **(Required)** + * Default: False +* chain : :ref:`Flag` **(Required)** + * Default: False +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* version : :ref:`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 \ No newline at end of file diff --git a/doc/api/caacl_add.md b/doc/api/caacl_add.md new file mode 100644 index 000000000..d37acc6f5 --- /dev/null +++ b/doc/api/caacl_add.md @@ -0,0 +1,45 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# caacl_add +Create a new CA ACL. + +### Arguments +|Name|Type|Required +|-|-|- +|cn|:ref:`Str`|True + +### Options +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* no_members : :ref:`Flag` **(Required)** + * Default: False +* description : :ref:`Str` +* ipaenabledflag : :ref:`Bool` +* ipacacategory : :ref:`StrEnum` + * Values: ('all',) +* ipacertprofilecategory : :ref:`StrEnum` + * Values: ('all',) +* usercategory : :ref:`StrEnum` + * Values: ('all',) +* hostcategory : :ref:`StrEnum` + * Values: ('all',) +* servicecategory : :ref:`StrEnum` + * Values: ('all',) +* setattr : :ref:`Str` +* addattr : :ref:`Str` +* version : :ref:`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 \ No newline at end of file diff --git a/doc/api/caacl_add_ca.md b/doc/api/caacl_add_ca.md new file mode 100644 index 000000000..d2f4c250e --- /dev/null +++ b/doc/api/caacl_add_ca.md @@ -0,0 +1,32 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# caacl_add_ca +Add CAs to a CA ACL. + +### Arguments +|Name|Type|Required +|-|-|- +|cn|:ref:`Str`|True + +### Options +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* no_members : :ref:`Flag` **(Required)** + * Default: False +* version : :ref:`Str` +* ca : :ref:`Str` + +### Output +|Name|Type +|-|- +|completed|Output +|failed|Output +|result|Entry + +[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end) +### Semantics + +### Notes + +### Version differences \ No newline at end of file diff --git a/doc/api/caacl_add_host.md b/doc/api/caacl_add_host.md new file mode 100644 index 000000000..078eaf8f5 --- /dev/null +++ b/doc/api/caacl_add_host.md @@ -0,0 +1,33 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# caacl_add_host +Add target hosts and hostgroups to a CA ACL. + +### Arguments +|Name|Type|Required +|-|-|- +|cn|:ref:`Str`|True + +### Options +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* no_members : :ref:`Flag` **(Required)** + * Default: False +* version : :ref:`Str` +* host : :ref:`Str` +* hostgroup : :ref:`Str` + +### Output +|Name|Type +|-|- +|completed|Output +|failed|Output +|result|Entry + +[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end) +### Semantics + +### Notes + +### Version differences \ No newline at end of file diff --git a/doc/api/caacl_add_profile.md b/doc/api/caacl_add_profile.md new file mode 100644 index 000000000..7687a7de6 --- /dev/null +++ b/doc/api/caacl_add_profile.md @@ -0,0 +1,32 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# caacl_add_profile +Add profiles to a CA ACL. + +### Arguments +|Name|Type|Required +|-|-|- +|cn|:ref:`Str`|True + +### Options +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* no_members : :ref:`Flag` **(Required)** + * Default: False +* version : :ref:`Str` +* certprofile : :ref:`Str` + +### Output +|Name|Type +|-|- +|completed|Output +|failed|Output +|result|Entry + +[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end) +### Semantics + +### Notes + +### Version differences \ No newline at end of file diff --git a/doc/api/caacl_add_service.md b/doc/api/caacl_add_service.md new file mode 100644 index 000000000..0f3207652 --- /dev/null +++ b/doc/api/caacl_add_service.md @@ -0,0 +1,32 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# caacl_add_service +Add services to a CA ACL. + +### Arguments +|Name|Type|Required +|-|-|- +|cn|:ref:`Str`|True + +### Options +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* no_members : :ref:`Flag` **(Required)** + * Default: False +* version : :ref:`Str` +* service : :ref:`Str` + +### Output +|Name|Type +|-|- +|completed|Output +|failed|Output +|result|Entry + +[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end) +### Semantics + +### Notes + +### Version differences \ No newline at end of file diff --git a/doc/api/caacl_add_user.md b/doc/api/caacl_add_user.md new file mode 100644 index 000000000..aef06299a --- /dev/null +++ b/doc/api/caacl_add_user.md @@ -0,0 +1,33 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# caacl_add_user +Add users and groups to a CA ACL. + +### Arguments +|Name|Type|Required +|-|-|- +|cn|:ref:`Str`|True + +### Options +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* no_members : :ref:`Flag` **(Required)** + * Default: False +* version : :ref:`Str` +* user : :ref:`Str` +* group : :ref:`Str` + +### Output +|Name|Type +|-|- +|completed|Output +|failed|Output +|result|Entry + +[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end) +### Semantics + +### Notes + +### Version differences \ No newline at end of file diff --git a/doc/api/caacl_del.md b/doc/api/caacl_del.md new file mode 100644 index 000000000..7b1568b91 --- /dev/null +++ b/doc/api/caacl_del.md @@ -0,0 +1,27 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# caacl_del +Delete a CA ACL. + +### Arguments +|Name|Type|Required +|-|-|- +|cn|:ref:`Str`|True + +### Options +* continue : :ref:`Flag` **(Required)** + * Default: False +* version : :ref:`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 \ No newline at end of file diff --git a/doc/api/caacl_disable.md b/doc/api/caacl_disable.md new file mode 100644 index 000000000..cc33797f7 --- /dev/null +++ b/doc/api/caacl_disable.md @@ -0,0 +1,25 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# caacl_disable +Disable a CA ACL. + +### Arguments +|Name|Type|Required +|-|-|- +|cn|:ref:`Str`|True + +### Options +* version : :ref:`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 \ No newline at end of file diff --git a/doc/api/caacl_enable.md b/doc/api/caacl_enable.md new file mode 100644 index 000000000..71db7cba9 --- /dev/null +++ b/doc/api/caacl_enable.md @@ -0,0 +1,25 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# caacl_enable +Enable a CA ACL. + +### Arguments +|Name|Type|Required +|-|-|- +|cn|:ref:`Str`|True + +### Options +* version : :ref:`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 \ No newline at end of file diff --git a/doc/api/caacl_find.md b/doc/api/caacl_find.md new file mode 100644 index 000000000..fb1f714ac --- /dev/null +++ b/doc/api/caacl_find.md @@ -0,0 +1,49 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# caacl_find +Search for CA ACLs. + +### Arguments +|Name|Type|Required +|-|-|- +|criteria|:ref:`Str`|False + +### Options +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* no_members : :ref:`Flag` **(Required)** + * Default: True +* cn : :ref:`Str` +* description : :ref:`Str` +* ipaenabledflag : :ref:`Bool` +* ipacacategory : :ref:`StrEnum` + * Values: ('all',) +* ipacertprofilecategory : :ref:`StrEnum` + * Values: ('all',) +* usercategory : :ref:`StrEnum` + * Values: ('all',) +* hostcategory : :ref:`StrEnum` + * Values: ('all',) +* servicecategory : :ref:`StrEnum` + * Values: ('all',) +* timelimit : :ref:`Int` +* sizelimit : :ref:`Int` +* version : :ref:`Str` +* pkey_only : :ref:`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 \ No newline at end of file diff --git a/doc/api/caacl_mod.md b/doc/api/caacl_mod.md new file mode 100644 index 000000000..74be61884 --- /dev/null +++ b/doc/api/caacl_mod.md @@ -0,0 +1,48 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# caacl_mod +Modify a CA ACL. + +### Arguments +|Name|Type|Required +|-|-|- +|cn|:ref:`Str`|True + +### Options +* rights : :ref:`Flag` **(Required)** + * Default: False +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* no_members : :ref:`Flag` **(Required)** + * Default: False +* description : :ref:`Str` +* ipaenabledflag : :ref:`Bool` +* ipacacategory : :ref:`StrEnum` + * Values: ('all',) +* ipacertprofilecategory : :ref:`StrEnum` + * Values: ('all',) +* usercategory : :ref:`StrEnum` + * Values: ('all',) +* hostcategory : :ref:`StrEnum` + * Values: ('all',) +* servicecategory : :ref:`StrEnum` + * Values: ('all',) +* setattr : :ref:`Str` +* addattr : :ref:`Str` +* delattr : :ref:`Str` +* version : :ref:`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 \ No newline at end of file diff --git a/doc/api/caacl_remove_ca.md b/doc/api/caacl_remove_ca.md new file mode 100644 index 000000000..01e7b6ca3 --- /dev/null +++ b/doc/api/caacl_remove_ca.md @@ -0,0 +1,32 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# caacl_remove_ca +Remove CAs from a CA ACL. + +### Arguments +|Name|Type|Required +|-|-|- +|cn|:ref:`Str`|True + +### Options +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* no_members : :ref:`Flag` **(Required)** + * Default: False +* version : :ref:`Str` +* ca : :ref:`Str` + +### Output +|Name|Type +|-|- +|completed|Output +|failed|Output +|result|Entry + +[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end) +### Semantics + +### Notes + +### Version differences \ No newline at end of file diff --git a/doc/api/caacl_remove_host.md b/doc/api/caacl_remove_host.md new file mode 100644 index 000000000..7a5d99380 --- /dev/null +++ b/doc/api/caacl_remove_host.md @@ -0,0 +1,33 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# caacl_remove_host +Remove target hosts and hostgroups from a CA ACL. + +### Arguments +|Name|Type|Required +|-|-|- +|cn|:ref:`Str`|True + +### Options +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* no_members : :ref:`Flag` **(Required)** + * Default: False +* version : :ref:`Str` +* host : :ref:`Str` +* hostgroup : :ref:`Str` + +### Output +|Name|Type +|-|- +|completed|Output +|failed|Output +|result|Entry + +[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end) +### Semantics + +### Notes + +### Version differences \ No newline at end of file diff --git a/doc/api/caacl_remove_profile.md b/doc/api/caacl_remove_profile.md new file mode 100644 index 000000000..27ea310db --- /dev/null +++ b/doc/api/caacl_remove_profile.md @@ -0,0 +1,32 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# caacl_remove_profile +Remove profiles from a CA ACL. + +### Arguments +|Name|Type|Required +|-|-|- +|cn|:ref:`Str`|True + +### Options +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* no_members : :ref:`Flag` **(Required)** + * Default: False +* version : :ref:`Str` +* certprofile : :ref:`Str` + +### Output +|Name|Type +|-|- +|completed|Output +|failed|Output +|result|Entry + +[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end) +### Semantics + +### Notes + +### Version differences \ No newline at end of file diff --git a/doc/api/caacl_remove_service.md b/doc/api/caacl_remove_service.md new file mode 100644 index 000000000..df17bf477 --- /dev/null +++ b/doc/api/caacl_remove_service.md @@ -0,0 +1,32 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# caacl_remove_service +Remove services from a CA ACL. + +### Arguments +|Name|Type|Required +|-|-|- +|cn|:ref:`Str`|True + +### Options +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* no_members : :ref:`Flag` **(Required)** + * Default: False +* version : :ref:`Str` +* service : :ref:`Str` + +### Output +|Name|Type +|-|- +|completed|Output +|failed|Output +|result|Entry + +[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end) +### Semantics + +### Notes + +### Version differences \ No newline at end of file diff --git a/doc/api/caacl_remove_user.md b/doc/api/caacl_remove_user.md new file mode 100644 index 000000000..6811283aa --- /dev/null +++ b/doc/api/caacl_remove_user.md @@ -0,0 +1,33 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# caacl_remove_user +Remove users and groups from a CA ACL. + +### Arguments +|Name|Type|Required +|-|-|- +|cn|:ref:`Str`|True + +### Options +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* no_members : :ref:`Flag` **(Required)** + * Default: False +* version : :ref:`Str` +* user : :ref:`Str` +* group : :ref:`Str` + +### Output +|Name|Type +|-|- +|completed|Output +|failed|Output +|result|Entry + +[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end) +### Semantics + +### Notes + +### Version differences \ No newline at end of file diff --git a/doc/api/caacl_show.md b/doc/api/caacl_show.md new file mode 100644 index 000000000..f6c525ef8 --- /dev/null +++ b/doc/api/caacl_show.md @@ -0,0 +1,33 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# caacl_show +Display the properties of a CA ACL. + +### Arguments +|Name|Type|Required +|-|-|- +|cn|:ref:`Str`|True + +### Options +* rights : :ref:`Flag` **(Required)** + * Default: False +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* no_members : :ref:`Flag` **(Required)** + * Default: False +* version : :ref:`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 \ No newline at end of file diff --git a/doc/api/cert_find.md b/doc/api/cert_find.md new file mode 100644 index 000000000..61774e69c --- /dev/null +++ b/doc/api/cert_find.md @@ -0,0 +1,61 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# cert_find +Search for existing certificates. + +### Arguments +|Name|Type|Required +|-|-|- +|criteria|:ref:`Str`|False + +### Options +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* no_members : :ref:`Flag` **(Required)** + * Default: True +* certificate : :ref:`Certificate` +* issuer : :ref:`DNParam` +* revocation_reason : :ref:`Int` +* cacn : :ref:`Str` +* subject : :ref:`Str` +* min_serial_number : :ref:`SerialNumber` +* max_serial_number : :ref:`SerialNumber` +* exactly : :ref:`Flag` + * Default: False +* validnotafter_from : :ref:`DateTime` +* validnotafter_to : :ref:`DateTime` +* validnotbefore_from : :ref:`DateTime` +* validnotbefore_to : :ref:`DateTime` +* issuedon_from : :ref:`DateTime` +* issuedon_to : :ref:`DateTime` +* revokedon_from : :ref:`DateTime` +* revokedon_to : :ref:`DateTime` +* status : :ref:`StrEnum` + * Values: ('VALID', 'INVALID', 'REVOKED', 'EXPIRED', 'REVOKED_EXPIRED') +* pkey_only : :ref:`Flag` + * Default: False +* timelimit : :ref:`Int` +* sizelimit : :ref:`Int` +* version : :ref:`Str` +* user : :ref:`Str` +* no_user : :ref:`Str` +* host : :ref:`Str` +* no_host : :ref:`Str` +* service : :ref:`Principal` +* no_service : :ref:`Principal` + +### 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 \ No newline at end of file diff --git a/doc/api/cert_remove_hold.md b/doc/api/cert_remove_hold.md new file mode 100644 index 000000000..66fdad69a --- /dev/null +++ b/doc/api/cert_remove_hold.md @@ -0,0 +1,25 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# cert_remove_hold +Take a revoked certificate off hold. + +### Arguments +|Name|Type|Required +|-|-|- +|serial_number|:ref:`SerialNumber`|True + +### Options +* cacn : :ref:`Str` + * Default: ipa +* version : :ref:`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 \ No newline at end of file diff --git a/doc/api/cert_request.md b/doc/api/cert_request.md new file mode 100644 index 000000000..419305f4e --- /dev/null +++ b/doc/api/cert_request.md @@ -0,0 +1,39 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# cert_request +Submit a certificate signing request. + +### Arguments +|Name|Type|Required +|-|-|- +|csr|:ref:`CertificateSigningRequest`|True + +### Options +* request_type : :ref:`Str` **(Required)** + * Default: pkcs10 +* principal : :ref:`Principal` **(Required)** +* add : :ref:`Flag` **(Required)** + * Default: False +* chain : :ref:`Flag` **(Required)** + * Default: False +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* profile_id : :ref:`Str` +* cacn : :ref:`Str` + * Default: ipa +* version : :ref:`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 \ No newline at end of file diff --git a/doc/api/cert_revoke.md b/doc/api/cert_revoke.md new file mode 100644 index 000000000..326f3e5ef --- /dev/null +++ b/doc/api/cert_revoke.md @@ -0,0 +1,27 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# cert_revoke +Revoke a certificate. + +### Arguments +|Name|Type|Required +|-|-|- +|serial_number|:ref:`SerialNumber`|True + +### Options +* revocation_reason : :ref:`Int` **(Required)** + * Default: 0 +* cacn : :ref:`Str` + * Default: ipa +* version : :ref:`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 \ No newline at end of file diff --git a/doc/api/cert_show.md b/doc/api/cert_show.md new file mode 100644 index 000000000..bfc6b001b --- /dev/null +++ b/doc/api/cert_show.md @@ -0,0 +1,36 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# cert_show +Retrieve an existing certificate. + +### Arguments +|Name|Type|Required +|-|-|- +|serial_number|:ref:`SerialNumber`|True + +### Options +* chain : :ref:`Flag` **(Required)** + * Default: False +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* no_members : :ref:`Flag` **(Required)** + * Default: False +* cacn : :ref:`Str` + * Default: ipa +* out : :ref:`Str` +* version : :ref:`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 \ No newline at end of file diff --git a/doc/api/cert_status.md b/doc/api/cert_status.md new file mode 100644 index 000000000..edb4c4e23 --- /dev/null +++ b/doc/api/cert_status.md @@ -0,0 +1,31 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# cert_status +Check the status of a certificate signing request. + +### Arguments +|Name|Type|Required +|-|-|- +|request_id|:ref:`Str`|True + +### Options +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* cacn : :ref:`Str` + * Default: ipa +* version : :ref:`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 \ No newline at end of file diff --git a/doc/api/certmap_match.md b/doc/api/certmap_match.md new file mode 100644 index 000000000..86129902e --- /dev/null +++ b/doc/api/certmap_match.md @@ -0,0 +1,36 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# certmap_match + +Search for users matching the provided certificate. + +This command relies on SSSD to retrieve the list of matching users and +may return cached data. For more information on purging SSSD cache, +please refer to sss_cache documentation. + + +### Arguments +|Name|Type|Required +|-|-|- +|certificate|:ref:`Certificate`|True + +### Options +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* version : :ref:`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 \ No newline at end of file diff --git a/doc/api/certmapconfig_mod.md b/doc/api/certmapconfig_mod.md new file mode 100644 index 000000000..28087aa4c --- /dev/null +++ b/doc/api/certmapconfig_mod.md @@ -0,0 +1,33 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# certmapconfig_mod +Modify Certificate Identity Mapping configuration. + +### Arguments +No arguments. + +### Options +* rights : :ref:`Flag` **(Required)** + * Default: False +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* ipacertmappromptusername : :ref:`Bool` +* setattr : :ref:`Str` +* addattr : :ref:`Str` +* delattr : :ref:`Str` +* version : :ref:`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 \ No newline at end of file diff --git a/doc/api/certmapconfig_show.md b/doc/api/certmapconfig_show.md new file mode 100644 index 000000000..b913e6ea1 --- /dev/null +++ b/doc/api/certmapconfig_show.md @@ -0,0 +1,29 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# certmapconfig_show +Show the current Certificate Identity Mapping configuration. + +### Arguments +No arguments. + +### Options +* rights : :ref:`Flag` **(Required)** + * Default: False +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* version : :ref:`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 \ No newline at end of file diff --git a/doc/api/certmaprule_add.md b/doc/api/certmaprule_add.md new file mode 100644 index 000000000..22aafb692 --- /dev/null +++ b/doc/api/certmaprule_add.md @@ -0,0 +1,38 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# certmaprule_add +Create a new Certificate Identity Mapping Rule. + +### Arguments +|Name|Type|Required +|-|-|- +|cn|:ref:`Str`|True + +### Options +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* description : :ref:`Str` +* ipacertmapmaprule : :ref:`Str` +* ipacertmapmatchrule : :ref:`Str` +* associateddomain : :ref:`DNSNameParam` +* ipacertmappriority : :ref:`Int` +* ipaenabledflag : :ref:`Flag` + * Default: True +* setattr : :ref:`Str` +* addattr : :ref:`Str` +* version : :ref:`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 \ No newline at end of file diff --git a/doc/api/certmaprule_del.md b/doc/api/certmaprule_del.md new file mode 100644 index 000000000..86eec333b --- /dev/null +++ b/doc/api/certmaprule_del.md @@ -0,0 +1,27 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# certmaprule_del +Delete a Certificate Identity Mapping Rule. + +### Arguments +|Name|Type|Required +|-|-|- +|cn|:ref:`Str`|True + +### Options +* continue : :ref:`Flag` **(Required)** + * Default: False +* version : :ref:`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 \ No newline at end of file diff --git a/doc/api/certmaprule_disable.md b/doc/api/certmaprule_disable.md new file mode 100644 index 000000000..cfc702140 --- /dev/null +++ b/doc/api/certmaprule_disable.md @@ -0,0 +1,25 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# certmaprule_disable +Disable a Certificate Identity Mapping Rule. + +### Arguments +|Name|Type|Required +|-|-|- +|cn|:ref:`Str`|True + +### Options +* version : :ref:`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 \ No newline at end of file diff --git a/doc/api/certmaprule_enable.md b/doc/api/certmaprule_enable.md new file mode 100644 index 000000000..715aca435 --- /dev/null +++ b/doc/api/certmaprule_enable.md @@ -0,0 +1,25 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# certmaprule_enable +Enable a Certificate Identity Mapping Rule. + +### Arguments +|Name|Type|Required +|-|-|- +|cn|:ref:`Str`|True + +### Options +* version : :ref:`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 \ No newline at end of file diff --git a/doc/api/certmaprule_find.md b/doc/api/certmaprule_find.md new file mode 100644 index 000000000..d37dfd94e --- /dev/null +++ b/doc/api/certmaprule_find.md @@ -0,0 +1,42 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# certmaprule_find +Search for Certificate Identity Mapping Rules. + +### Arguments +|Name|Type|Required +|-|-|- +|criteria|:ref:`Str`|False + +### Options +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* cn : :ref:`Str` +* description : :ref:`Str` +* ipacertmapmaprule : :ref:`Str` +* ipacertmapmatchrule : :ref:`Str` +* associateddomain : :ref:`DNSNameParam` +* ipacertmappriority : :ref:`Int` +* ipaenabledflag : :ref:`Bool` + * Default: True +* timelimit : :ref:`Int` +* sizelimit : :ref:`Int` +* version : :ref:`Str` +* pkey_only : :ref:`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 \ No newline at end of file diff --git a/doc/api/certmaprule_mod.md b/doc/api/certmaprule_mod.md new file mode 100644 index 000000000..1c782478e --- /dev/null +++ b/doc/api/certmaprule_mod.md @@ -0,0 +1,41 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# certmaprule_mod +Modify a Certificate Identity Mapping Rule. + +### Arguments +|Name|Type|Required +|-|-|- +|cn|:ref:`Str`|True + +### Options +* rights : :ref:`Flag` **(Required)** + * Default: False +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* description : :ref:`Str` +* ipacertmapmaprule : :ref:`Str` +* ipacertmapmatchrule : :ref:`Str` +* associateddomain : :ref:`DNSNameParam` +* ipacertmappriority : :ref:`Int` +* ipaenabledflag : :ref:`Flag` + * Default: True +* setattr : :ref:`Str` +* addattr : :ref:`Str` +* delattr : :ref:`Str` +* version : :ref:`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 \ No newline at end of file diff --git a/doc/api/certmaprule_show.md b/doc/api/certmaprule_show.md new file mode 100644 index 000000000..b59aecf45 --- /dev/null +++ b/doc/api/certmaprule_show.md @@ -0,0 +1,31 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# certmaprule_show +Display information about a Certificate Identity Mapping Rule. + +### Arguments +|Name|Type|Required +|-|-|- +|cn|:ref:`Str`|True + +### Options +* rights : :ref:`Flag` **(Required)** + * Default: False +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* version : :ref:`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 \ No newline at end of file diff --git a/doc/api/certprofile_del.md b/doc/api/certprofile_del.md new file mode 100644 index 000000000..a0b36ccbf --- /dev/null +++ b/doc/api/certprofile_del.md @@ -0,0 +1,27 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# certprofile_del +Delete a Certificate Profile. + +### Arguments +|Name|Type|Required +|-|-|- +|cn|:ref:`Str`|True + +### Options +* continue : :ref:`Flag` **(Required)** + * Default: False +* version : :ref:`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 \ No newline at end of file diff --git a/doc/api/certprofile_find.md b/doc/api/certprofile_find.md new file mode 100644 index 000000000..5997c9340 --- /dev/null +++ b/doc/api/certprofile_find.md @@ -0,0 +1,38 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# certprofile_find +Search for Certificate Profiles. + +### Arguments +|Name|Type|Required +|-|-|- +|criteria|:ref:`Str`|False + +### Options +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* cn : :ref:`Str` +* description : :ref:`Str` +* ipacertprofilestoreissued : :ref:`Bool` + * Default: True +* timelimit : :ref:`Int` +* sizelimit : :ref:`Int` +* version : :ref:`Str` +* pkey_only : :ref:`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 \ No newline at end of file diff --git a/doc/api/certprofile_import.md b/doc/api/certprofile_import.md new file mode 100644 index 000000000..cdcebf4a0 --- /dev/null +++ b/doc/api/certprofile_import.md @@ -0,0 +1,33 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# certprofile_import +Import a Certificate Profile. + +### Arguments +|Name|Type|Required +|-|-|- +|cn|:ref:`Str`|True + +### Options +* description : :ref:`Str` **(Required)** +* ipacertprofilestoreissued : :ref:`Bool` **(Required)** + * Default: True +* file : :ref:`Str` **(Required)** +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* version : :ref:`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 \ No newline at end of file diff --git a/doc/api/certprofile_mod.md b/doc/api/certprofile_mod.md new file mode 100644 index 000000000..de0dfef66 --- /dev/null +++ b/doc/api/certprofile_mod.md @@ -0,0 +1,38 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# certprofile_mod +Modify Certificate Profile configuration. + +### Arguments +|Name|Type|Required +|-|-|- +|cn|:ref:`Str`|True + +### Options +* rights : :ref:`Flag` **(Required)** + * Default: False +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* description : :ref:`Str` +* ipacertprofilestoreissued : :ref:`Bool` + * Default: True +* setattr : :ref:`Str` +* addattr : :ref:`Str` +* delattr : :ref:`Str` +* file : :ref:`Str` +* version : :ref:`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 \ No newline at end of file diff --git a/doc/api/certprofile_show.md b/doc/api/certprofile_show.md new file mode 100644 index 000000000..551ac2b69 --- /dev/null +++ b/doc/api/certprofile_show.md @@ -0,0 +1,32 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# certprofile_show +Display the properties of a Certificate Profile. + +### Arguments +|Name|Type|Required +|-|-|- +|cn|:ref:`Str`|True + +### Options +* rights : :ref:`Flag` **(Required)** + * Default: False +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* out : :ref:`Str` +* version : :ref:`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 \ No newline at end of file diff --git a/doc/api/class_find.md b/doc/api/class_find.md new file mode 100644 index 000000000..f78fa4006 --- /dev/null +++ b/doc/api/class_find.md @@ -0,0 +1,32 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# class_find +Search for classes. + +### Arguments +|Name|Type|Required +|-|-|- +|criteria|:ref:`Str`|False + +### Options +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* version : :ref:`Str` +* pkey_only : :ref:`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 \ No newline at end of file diff --git a/doc/api/class_show.md b/doc/api/class_show.md new file mode 100644 index 000000000..c54069fc1 --- /dev/null +++ b/doc/api/class_show.md @@ -0,0 +1,29 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# class_show +Display information about a class. + +### Arguments +|Name|Type|Required +|-|-|- +|full_name|:ref:`Str`|True + +### Options +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* version : :ref:`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 \ No newline at end of file diff --git a/doc/api/command_defaults.md b/doc/api/command_defaults.md new file mode 100644 index 000000000..968bf314b --- /dev/null +++ b/doc/api/command_defaults.md @@ -0,0 +1,25 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# command_defaults +Return command defaults + +### Arguments +|Name|Type|Required +|-|-|- +|full_name|:ref:`Str`|True + +### Options +* params : :ref:`Str` +* kw : :ref:`Dict` +* version : :ref:`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 \ No newline at end of file diff --git a/doc/api/command_find.md b/doc/api/command_find.md new file mode 100644 index 000000000..2803457ef --- /dev/null +++ b/doc/api/command_find.md @@ -0,0 +1,32 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# command_find +Search for commands. + +### Arguments +|Name|Type|Required +|-|-|- +|criteria|:ref:`Str`|False + +### Options +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* version : :ref:`Str` +* pkey_only : :ref:`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 \ No newline at end of file diff --git a/doc/api/command_show.md b/doc/api/command_show.md new file mode 100644 index 000000000..e2f64d125 --- /dev/null +++ b/doc/api/command_show.md @@ -0,0 +1,29 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# command_show +Display information about a command. + +### Arguments +|Name|Type|Required +|-|-|- +|full_name|:ref:`Str`|True + +### Options +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* version : :ref:`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 \ No newline at end of file diff --git a/doc/api/commands.rst b/doc/api/commands.rst new file mode 100644 index 000000000..b9d16071d --- /dev/null +++ b/doc/api/commands.rst @@ -0,0 +1,490 @@ +IPA API Commands +================= +.. toctree:: + :maxdepth: 1 + + + aci_add.md + aci_del.md + aci_find.md + aci_mod.md + aci_rename.md + aci_show.md + adtrust_is_enabled.md + automember_add.md + automember_add_condition.md + automember_default_group_remove.md + automember_default_group_set.md + automember_default_group_show.md + automember_del.md + automember_find.md + automember_find_orphans.md + automember_mod.md + automember_rebuild.md + automember_remove_condition.md + automember_show.md + automountkey_add.md + automountkey_del.md + automountkey_find.md + automountkey_mod.md + automountkey_show.md + automountlocation_add.md + automountlocation_del.md + automountlocation_find.md + automountlocation_show.md + automountlocation_tofiles.md + automountmap_add.md + automountmap_add_indirect.md + automountmap_del.md + automountmap_find.md + automountmap_mod.md + automountmap_show.md + batch.md + ca_add.md + ca_del.md + ca_disable.md + ca_enable.md + ca_find.md + ca_is_enabled.md + ca_mod.md + ca_show.md + caacl_add.md + caacl_add_ca.md + caacl_add_host.md + caacl_add_profile.md + caacl_add_service.md + caacl_add_user.md + caacl_del.md + caacl_disable.md + caacl_enable.md + caacl_find.md + caacl_mod.md + caacl_remove_ca.md + caacl_remove_host.md + caacl_remove_profile.md + caacl_remove_service.md + caacl_remove_user.md + caacl_show.md + cert_find.md + cert_remove_hold.md + cert_request.md + cert_revoke.md + cert_show.md + cert_status.md + certmap_match.md + certmapconfig_mod.md + certmapconfig_show.md + certmaprule_add.md + certmaprule_del.md + certmaprule_disable.md + certmaprule_enable.md + certmaprule_find.md + certmaprule_mod.md + certmaprule_show.md + certprofile_del.md + certprofile_find.md + certprofile_import.md + certprofile_mod.md + certprofile_show.md + class_find.md + class_show.md + command_defaults.md + command_find.md + command_show.md + compat_is_enabled.md + config_mod.md + config_show.md + cosentry_add.md + cosentry_del.md + cosentry_find.md + cosentry_mod.md + cosentry_show.md + delegation_add.md + delegation_del.md + delegation_find.md + delegation_mod.md + delegation_show.md + dns_is_enabled.md + dns_resolve.md + dns_update_system_records.md + dnsconfig_mod.md + dnsconfig_show.md + dnsforwardzone_add.md + dnsforwardzone_add_permission.md + dnsforwardzone_del.md + dnsforwardzone_disable.md + dnsforwardzone_enable.md + dnsforwardzone_find.md + dnsforwardzone_mod.md + dnsforwardzone_remove_permission.md + dnsforwardzone_show.md + dnsrecord_add.md + dnsrecord_del.md + dnsrecord_delentry.md + dnsrecord_find.md + dnsrecord_mod.md + dnsrecord_show.md + dnsrecord_split_parts.md + dnsserver_add.md + dnsserver_del.md + dnsserver_find.md + dnsserver_mod.md + dnsserver_show.md + dnszone_add.md + dnszone_add_permission.md + dnszone_del.md + dnszone_disable.md + dnszone_enable.md + dnszone_find.md + dnszone_mod.md + dnszone_remove_permission.md + dnszone_show.md + domainlevel_get.md + domainlevel_set.md + env.md + group_add.md + group_add_member.md + group_add_member_manager.md + group_del.md + group_detach.md + group_find.md + group_mod.md + group_remove_member.md + group_remove_member_manager.md + group_show.md + hbacrule_add.md + hbacrule_add_host.md + hbacrule_add_service.md + hbacrule_add_sourcehost.md + hbacrule_add_user.md + hbacrule_del.md + hbacrule_disable.md + hbacrule_enable.md + hbacrule_find.md + hbacrule_mod.md + hbacrule_remove_host.md + hbacrule_remove_service.md + hbacrule_remove_sourcehost.md + hbacrule_remove_user.md + hbacrule_show.md + hbacsvc_add.md + hbacsvc_del.md + hbacsvc_find.md + hbacsvc_mod.md + hbacsvc_show.md + hbacsvcgroup_add.md + hbacsvcgroup_add_member.md + hbacsvcgroup_del.md + hbacsvcgroup_find.md + hbacsvcgroup_mod.md + hbacsvcgroup_remove_member.md + hbacsvcgroup_show.md + hbactest.md + host_add.md + host_add_cert.md + host_add_managedby.md + host_add_principal.md + host_allow_create_keytab.md + host_allow_retrieve_keytab.md + host_del.md + host_disable.md + host_disallow_create_keytab.md + host_disallow_retrieve_keytab.md + host_find.md + host_mod.md + host_remove_cert.md + host_remove_managedby.md + host_remove_principal.md + host_show.md + hostgroup_add.md + hostgroup_add_member.md + hostgroup_add_member_manager.md + hostgroup_del.md + hostgroup_find.md + hostgroup_mod.md + hostgroup_remove_member.md + hostgroup_remove_member_manager.md + hostgroup_show.md + i18n_messages.md + idoverridegroup_add.md + idoverridegroup_del.md + idoverridegroup_find.md + idoverridegroup_mod.md + idoverridegroup_show.md + idoverrideuser_add.md + idoverrideuser_add_cert.md + idoverrideuser_del.md + idoverrideuser_find.md + idoverrideuser_mod.md + idoverrideuser_remove_cert.md + idoverrideuser_show.md + idp_add.md + idp_del.md + idp_find.md + idp_mod.md + idp_show.md + idrange_add.md + idrange_del.md + idrange_find.md + idrange_mod.md + idrange_show.md + idview_add.md + idview_apply.md + idview_del.md + idview_find.md + idview_mod.md + idview_show.md + idview_unapply.md + join.md + json_metadata.md + kra_is_enabled.md + krbtpolicy_mod.md + krbtpolicy_reset.md + krbtpolicy_show.md + location_add.md + location_del.md + location_find.md + location_mod.md + location_show.md + migrate_ds.md + netgroup_add.md + netgroup_add_member.md + netgroup_del.md + netgroup_find.md + netgroup_mod.md + netgroup_remove_member.md + netgroup_show.md + otpconfig_mod.md + otpconfig_show.md + otptoken_add.md + otptoken_add_managedby.md + otptoken_del.md + otptoken_find.md + otptoken_mod.md + otptoken_remove_managedby.md + otptoken_show.md + output_find.md + output_show.md + param_find.md + param_show.md + passwd.md + permission_add.md + permission_add_member.md + permission_add_noaci.md + permission_del.md + permission_find.md + permission_mod.md + permission_remove_member.md + permission_show.md + ping.md + pkinit_status.md + plugins.md + privilege_add.md + privilege_add_member.md + privilege_add_permission.md + privilege_del.md + privilege_find.md + privilege_mod.md + privilege_remove_member.md + privilege_remove_permission.md + privilege_show.md + pwpolicy_add.md + pwpolicy_del.md + pwpolicy_find.md + pwpolicy_mod.md + pwpolicy_show.md + radiusproxy_add.md + radiusproxy_del.md + radiusproxy_find.md + radiusproxy_mod.md + radiusproxy_show.md + realmdomains_mod.md + realmdomains_show.md + role_add.md + role_add_member.md + role_add_privilege.md + role_del.md + role_find.md + role_mod.md + role_remove_member.md + role_remove_privilege.md + role_show.md + schema.md + selfservice_add.md + selfservice_del.md + selfservice_find.md + selfservice_mod.md + selfservice_show.md + selinuxusermap_add.md + selinuxusermap_add_host.md + selinuxusermap_add_user.md + selinuxusermap_del.md + selinuxusermap_disable.md + selinuxusermap_enable.md + selinuxusermap_find.md + selinuxusermap_mod.md + selinuxusermap_remove_host.md + selinuxusermap_remove_user.md + selinuxusermap_show.md + server_conncheck.md + server_del.md + server_find.md + server_mod.md + server_role_find.md + server_role_show.md + server_show.md + server_state.md + service_add.md + service_add_cert.md + service_add_host.md + service_add_principal.md + service_add_smb.md + service_allow_create_keytab.md + service_allow_retrieve_keytab.md + service_del.md + service_disable.md + service_disallow_create_keytab.md + service_disallow_retrieve_keytab.md + service_find.md + service_mod.md + service_remove_cert.md + service_remove_host.md + service_remove_principal.md + service_show.md + servicedelegationrule_add.md + servicedelegationrule_add_member.md + servicedelegationrule_add_target.md + servicedelegationrule_del.md + servicedelegationrule_find.md + servicedelegationrule_remove_member.md + servicedelegationrule_remove_target.md + servicedelegationrule_show.md + servicedelegationtarget_add.md + servicedelegationtarget_add_member.md + servicedelegationtarget_del.md + servicedelegationtarget_find.md + servicedelegationtarget_remove_member.md + servicedelegationtarget_show.md + session_logout.md + sidgen_was_run.md + stageuser_activate.md + stageuser_add.md + stageuser_add_cert.md + stageuser_add_certmapdata.md + stageuser_add_manager.md + stageuser_add_principal.md + stageuser_del.md + stageuser_find.md + stageuser_mod.md + stageuser_remove_cert.md + stageuser_remove_certmapdata.md + stageuser_remove_manager.md + stageuser_remove_principal.md + stageuser_show.md + subid_add.md + subid_del.md + subid_find.md + subid_generate.md + subid_match.md + subid_mod.md + subid_show.md + subid_stats.md + sudocmd_add.md + sudocmd_del.md + sudocmd_find.md + sudocmd_mod.md + sudocmd_show.md + sudocmdgroup_add.md + sudocmdgroup_add_member.md + sudocmdgroup_del.md + sudocmdgroup_find.md + sudocmdgroup_mod.md + sudocmdgroup_remove_member.md + sudocmdgroup_show.md + sudorule_add.md + sudorule_add_allow_command.md + sudorule_add_deny_command.md + sudorule_add_host.md + sudorule_add_option.md + sudorule_add_runasgroup.md + sudorule_add_runasuser.md + sudorule_add_user.md + sudorule_del.md + sudorule_disable.md + sudorule_enable.md + sudorule_find.md + sudorule_mod.md + sudorule_remove_allow_command.md + sudorule_remove_deny_command.md + sudorule_remove_host.md + sudorule_remove_option.md + sudorule_remove_runasgroup.md + sudorule_remove_runasuser.md + sudorule_remove_user.md + sudorule_show.md + topic_find.md + topic_show.md + topologysegment_add.md + topologysegment_del.md + topologysegment_find.md + topologysegment_mod.md + topologysegment_reinitialize.md + topologysegment_show.md + topologysuffix_add.md + topologysuffix_del.md + topologysuffix_find.md + topologysuffix_mod.md + topologysuffix_show.md + topologysuffix_verify.md + trust_add.md + trust_del.md + trust_enable_agent.md + trust_fetch_domains.md + trust_find.md + trust_mod.md + trust_resolve.md + trust_show.md + trustconfig_mod.md + trustconfig_show.md + trustdomain_add.md + trustdomain_del.md + trustdomain_disable.md + trustdomain_enable.md + trustdomain_find.md + trustdomain_mod.md + user_add.md + user_add_cert.md + user_add_certmapdata.md + user_add_manager.md + user_add_principal.md + user_del.md + user_disable.md + user_enable.md + user_find.md + user_mod.md + user_remove_cert.md + user_remove_certmapdata.md + user_remove_manager.md + user_remove_principal.md + user_show.md + user_stage.md + user_status.md + user_undel.md + user_unlock.md + vault_add_internal.md + vault_add_member.md + vault_add_owner.md + vault_archive_internal.md + vault_del.md + vault_find.md + vault_mod_internal.md + vault_remove_member.md + vault_remove_owner.md + vault_retrieve_internal.md + vault_show.md + vaultconfig_show.md + vaultcontainer_add_owner.md + vaultcontainer_del.md + vaultcontainer_remove_owner.md + vaultcontainer_show.md + whoami.md \ No newline at end of file diff --git a/doc/api/compat_is_enabled.md b/doc/api/compat_is_enabled.md new file mode 100644 index 000000000..d767974cd --- /dev/null +++ b/doc/api/compat_is_enabled.md @@ -0,0 +1,21 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# compat_is_enabled +Determine whether Schema Compatibility plugin is configured to serve trusted domain users and groups + +### Arguments +No arguments. + +### Options +* version : :ref:`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 \ No newline at end of file diff --git a/doc/api/config_mod.md b/doc/api/config_mod.md new file mode 100644 index 000000000..f7c1611a6 --- /dev/null +++ b/doc/api/config_mod.md @@ -0,0 +1,62 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# config_mod +Modify configuration options. + +### Arguments +No arguments. + +### Options +* rights : :ref:`Flag` **(Required)** + * Default: False +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* ipamaxusernamelength : :ref:`Int` +* ipamaxhostnamelength : :ref:`Int` +* ipahomesrootdir : :ref:`IA5Str` +* ipadefaultloginshell : :ref:`Str` +* ipadefaultprimarygroup : :ref:`Str` +* ipadefaultemaildomain : :ref:`Str` +* ipasearchtimelimit : :ref:`Int` +* ipasearchrecordslimit : :ref:`Int` +* ipausersearchfields : :ref:`IA5Str` +* ipagroupsearchfields : :ref:`IA5Str` +* ipamigrationenabled : :ref:`Bool` +* ipagroupobjectclasses : :ref:`Str` +* ipauserobjectclasses : :ref:`Str` +* ipapwdexpadvnotify : :ref:`Int` +* ipaconfigstring : :ref:`StrEnum` + * Values: ('AllowNThash', 'KDC:Disable Last Success', 'KDC:Disable Lockout', 'KDC:Disable Default Preauth for SPNs') +* ipaselinuxusermaporder : :ref:`Str` +* ipaselinuxusermapdefault : :ref:`Str` +* ipakrbauthzdata : :ref:`StrEnum` + * Values: ('MS-PAC', 'PAD', 'nfs:NONE') +* ipauserauthtype : :ref:`StrEnum` + * Values: ('password', 'radius', 'otp', 'pkinit', 'hardened', 'idp', 'disabled') +* ipauserdefaultsubordinateid : :ref:`Bool` +* ca_renewal_master_server : :ref:`Str` +* ipadomainresolutionorder : :ref:`Str` +* enable_sid : :ref:`Flag` + * Default: False +* add_sids : :ref:`Flag` + * Default: False +* netbios_name : :ref:`Str` +* setattr : :ref:`Str` +* addattr : :ref:`Str` +* delattr : :ref:`Str` +* version : :ref:`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 \ No newline at end of file diff --git a/doc/api/config_show.md b/doc/api/config_show.md new file mode 100644 index 000000000..0a16e68dd --- /dev/null +++ b/doc/api/config_show.md @@ -0,0 +1,29 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# config_show +Show the current configuration. + +### Arguments +No arguments. + +### Options +* rights : :ref:`Flag` **(Required)** + * Default: False +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* version : :ref:`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 \ No newline at end of file diff --git a/doc/api/cosentry_add.md b/doc/api/cosentry_add.md new file mode 100644 index 000000000..93ac32810 --- /dev/null +++ b/doc/api/cosentry_add.md @@ -0,0 +1,33 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# cosentry_add +Add Class of Service entry + +### Arguments +|Name|Type|Required +|-|-|- +|cn|:ref:`Str`|True + +### Options +* krbpwdpolicyreference : :ref:`DNParam` **(Required)** +* cospriority : :ref:`Int` **(Required)** +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* setattr : :ref:`Str` +* addattr : :ref:`Str` +* version : :ref:`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 \ No newline at end of file diff --git a/doc/api/cosentry_del.md b/doc/api/cosentry_del.md new file mode 100644 index 000000000..357e3afd6 --- /dev/null +++ b/doc/api/cosentry_del.md @@ -0,0 +1,27 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# cosentry_del +Delete Class of Service entry + +### Arguments +|Name|Type|Required +|-|-|- +|cn|:ref:`Str`|True + +### Options +* continue : :ref:`Flag` **(Required)** + * Default: False +* version : :ref:`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 \ No newline at end of file diff --git a/doc/api/cosentry_find.md b/doc/api/cosentry_find.md new file mode 100644 index 000000000..964b94350 --- /dev/null +++ b/doc/api/cosentry_find.md @@ -0,0 +1,37 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# cosentry_find +Search for Class of Service entry + +### Arguments +|Name|Type|Required +|-|-|- +|criteria|:ref:`Str`|False + +### Options +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* cn : :ref:`Str` +* krbpwdpolicyreference : :ref:`DNParam` +* cospriority : :ref:`Int` +* timelimit : :ref:`Int` +* sizelimit : :ref:`Int` +* version : :ref:`Str` +* pkey_only : :ref:`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 \ No newline at end of file diff --git a/doc/api/cosentry_mod.md b/doc/api/cosentry_mod.md new file mode 100644 index 000000000..16101519b --- /dev/null +++ b/doc/api/cosentry_mod.md @@ -0,0 +1,36 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# cosentry_mod +Modify Class of Service entry + +### Arguments +|Name|Type|Required +|-|-|- +|cn|:ref:`Str`|True + +### Options +* rights : :ref:`Flag` **(Required)** + * Default: False +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* krbpwdpolicyreference : :ref:`DNParam` +* cospriority : :ref:`Int` +* setattr : :ref:`Str` +* addattr : :ref:`Str` +* delattr : :ref:`Str` +* version : :ref:`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 \ No newline at end of file diff --git a/doc/api/cosentry_show.md b/doc/api/cosentry_show.md new file mode 100644 index 000000000..7187a75ee --- /dev/null +++ b/doc/api/cosentry_show.md @@ -0,0 +1,31 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# cosentry_show +Display Class of Service entry + +### Arguments +|Name|Type|Required +|-|-|- +|cn|:ref:`Str`|True + +### Options +* rights : :ref:`Flag` **(Required)** + * Default: False +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* version : :ref:`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 \ No newline at end of file diff --git a/doc/api/delegation_add.md b/doc/api/delegation_add.md new file mode 100644 index 000000000..69ca2223e --- /dev/null +++ b/doc/api/delegation_add.md @@ -0,0 +1,33 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# delegation_add +Add a new delegation. + +### Arguments +|Name|Type|Required +|-|-|- +|aciname|:ref:`Str`|True + +### Options +* attrs : :ref:`Str` **(Required)** +* memberof : :ref:`Str` **(Required)** +* group : :ref:`Str` **(Required)** +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* permissions : :ref:`Str` +* version : :ref:`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 \ No newline at end of file diff --git a/doc/api/delegation_del.md b/doc/api/delegation_del.md new file mode 100644 index 000000000..5d063291f --- /dev/null +++ b/doc/api/delegation_del.md @@ -0,0 +1,25 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# delegation_del +Delete a delegation. + +### Arguments +|Name|Type|Required +|-|-|- +|aciname|:ref:`Str`|True + +### Options +* version : :ref:`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 \ No newline at end of file diff --git a/doc/api/delegation_find.md b/doc/api/delegation_find.md new file mode 100644 index 000000000..ae2d42e03 --- /dev/null +++ b/doc/api/delegation_find.md @@ -0,0 +1,37 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# delegation_find +Search for delegations. + +### Arguments +|Name|Type|Required +|-|-|- +|criteria|:ref:`Str`|False + +### Options +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* aciname : :ref:`Str` +* permissions : :ref:`Str` +* attrs : :ref:`Str` +* memberof : :ref:`Str` +* group : :ref:`Str` +* pkey_only : :ref:`Flag` + * Default: False +* version : :ref:`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 \ No newline at end of file diff --git a/doc/api/delegation_mod.md b/doc/api/delegation_mod.md new file mode 100644 index 000000000..56e7a9bad --- /dev/null +++ b/doc/api/delegation_mod.md @@ -0,0 +1,33 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# delegation_mod +Modify a delegation. + +### Arguments +|Name|Type|Required +|-|-|- +|aciname|:ref:`Str`|True + +### Options +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* permissions : :ref:`Str` +* attrs : :ref:`Str` +* memberof : :ref:`Str` +* group : :ref:`Str` +* version : :ref:`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 \ No newline at end of file diff --git a/doc/api/delegation_show.md b/doc/api/delegation_show.md new file mode 100644 index 000000000..adba7f848 --- /dev/null +++ b/doc/api/delegation_show.md @@ -0,0 +1,29 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# delegation_show +Display information about a delegation. + +### Arguments +|Name|Type|Required +|-|-|- +|aciname|:ref:`Str`|True + +### Options +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* version : :ref:`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 \ No newline at end of file diff --git a/doc/api/dns_is_enabled.md b/doc/api/dns_is_enabled.md new file mode 100644 index 000000000..948638424 --- /dev/null +++ b/doc/api/dns_is_enabled.md @@ -0,0 +1,23 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# dns_is_enabled +Checks if any of the servers has the DNS service enabled. + +### Arguments +No arguments. + +### Options +* version : :ref:`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 \ No newline at end of file diff --git a/doc/api/dns_resolve.md b/doc/api/dns_resolve.md new file mode 100644 index 000000000..26e62d344 --- /dev/null +++ b/doc/api/dns_resolve.md @@ -0,0 +1,25 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# dns_resolve +Resolve a host name in DNS. (Deprecated) + +### Arguments +|Name|Type|Required +|-|-|- +|hostname|:ref:`Str`|True + +### Options +* version : :ref:`Str` + +### Output +|Name|Type +|-|- +|result|Output +|summary|Output +|value|Output + +[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end) +### Semantics + +### Notes + +### Version differences \ No newline at end of file diff --git a/doc/api/dns_update_system_records.md b/doc/api/dns_update_system_records.md new file mode 100644 index 000000000..a07ad3f12 --- /dev/null +++ b/doc/api/dns_update_system_records.md @@ -0,0 +1,28 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# dns_update_system_records +Update location and IPA server DNS records + +### Arguments +No arguments. + +### Options +* dry_run : :ref:`Flag` **(Required)** + * Default: False +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* version : :ref:`Str` + +### Output +|Name|Type +|-|- +|result|Entry +|value|Output + +[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end) +### Semantics + +### Notes + +### Version differences \ No newline at end of file diff --git a/doc/api/dnsconfig_mod.md b/doc/api/dnsconfig_mod.md new file mode 100644 index 000000000..6c868f841 --- /dev/null +++ b/doc/api/dnsconfig_mod.md @@ -0,0 +1,37 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# dnsconfig_mod +Modify global DNS configuration. + +### Arguments +No arguments. + +### Options +* rights : :ref:`Flag` **(Required)** + * Default: False +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* idnsforwarders : :ref:`Str` +* idnsforwardpolicy : :ref:`StrEnum` + * Values: ('only', 'first', 'none') +* idnsallowsyncptr : :ref:`Bool` +* idnszonerefresh : :ref:`Int` +* setattr : :ref:`Str` +* addattr : :ref:`Str` +* delattr : :ref:`Str` +* version : :ref:`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 \ No newline at end of file diff --git a/doc/api/dnsconfig_show.md b/doc/api/dnsconfig_show.md new file mode 100644 index 000000000..d18b6661d --- /dev/null +++ b/doc/api/dnsconfig_show.md @@ -0,0 +1,29 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# dnsconfig_show +Show the current global DNS configuration. + +### Arguments +No arguments. + +### Options +* rights : :ref:`Flag` **(Required)** + * Default: False +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* version : :ref:`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 \ No newline at end of file diff --git a/doc/api/dnsforwardzone_add.md b/doc/api/dnsforwardzone_add.md new file mode 100644 index 000000000..3d85631f4 --- /dev/null +++ b/doc/api/dnsforwardzone_add.md @@ -0,0 +1,37 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# dnsforwardzone_add +Create new DNS forward zone. + +### Arguments +|Name|Type|Required +|-|-|- +|idnsname|:ref:`DNSNameParam`|True + +### Options +* skip_overlap_check : :ref:`Flag` **(Required)** + * Default: False +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* name_from_ip : :ref:`Str` +* idnsforwarders : :ref:`Str` +* idnsforwardpolicy : :ref:`StrEnum` + * Values: ('only', 'first', 'none') +* setattr : :ref:`Str` +* addattr : :ref:`Str` +* version : :ref:`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 \ No newline at end of file diff --git a/doc/api/dnsforwardzone_add_permission.md b/doc/api/dnsforwardzone_add_permission.md new file mode 100644 index 000000000..fd653887c --- /dev/null +++ b/doc/api/dnsforwardzone_add_permission.md @@ -0,0 +1,25 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# dnsforwardzone_add_permission +Add a permission for per-forward zone access delegation. + +### Arguments +|Name|Type|Required +|-|-|- +|idnsname|:ref:`DNSNameParam`|True + +### Options +* version : :ref:`Str` + +### Output +|Name|Type +|-|- +|result|Output +|summary|Output +|value|Output + +[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end) +### Semantics + +### Notes + +### Version differences \ No newline at end of file diff --git a/doc/api/dnsforwardzone_del.md b/doc/api/dnsforwardzone_del.md new file mode 100644 index 000000000..d9058b262 --- /dev/null +++ b/doc/api/dnsforwardzone_del.md @@ -0,0 +1,27 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# dnsforwardzone_del +Delete DNS forward zone. + +### Arguments +|Name|Type|Required +|-|-|- +|idnsname|:ref:`DNSNameParam`|True + +### Options +* continue : :ref:`Flag` **(Required)** + * Default: False +* version : :ref:`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 \ No newline at end of file diff --git a/doc/api/dnsforwardzone_disable.md b/doc/api/dnsforwardzone_disable.md new file mode 100644 index 000000000..3e177eb17 --- /dev/null +++ b/doc/api/dnsforwardzone_disable.md @@ -0,0 +1,25 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# dnsforwardzone_disable +Disable DNS Forward Zone. + +### Arguments +|Name|Type|Required +|-|-|- +|idnsname|:ref:`DNSNameParam`|True + +### Options +* version : :ref:`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 \ No newline at end of file diff --git a/doc/api/dnsforwardzone_enable.md b/doc/api/dnsforwardzone_enable.md new file mode 100644 index 000000000..a480c51ee --- /dev/null +++ b/doc/api/dnsforwardzone_enable.md @@ -0,0 +1,25 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# dnsforwardzone_enable +Enable DNS Forward Zone. + +### Arguments +|Name|Type|Required +|-|-|- +|idnsname|:ref:`DNSNameParam`|True + +### Options +* version : :ref:`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 \ No newline at end of file diff --git a/doc/api/dnsforwardzone_find.md b/doc/api/dnsforwardzone_find.md new file mode 100644 index 000000000..9c055e8c2 --- /dev/null +++ b/doc/api/dnsforwardzone_find.md @@ -0,0 +1,40 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# dnsforwardzone_find +Search for DNS forward zones. + +### Arguments +|Name|Type|Required +|-|-|- +|criteria|:ref:`Str`|False + +### Options +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* idnsname : :ref:`DNSNameParam` +* name_from_ip : :ref:`Str` +* idnszoneactive : :ref:`Bool` +* idnsforwarders : :ref:`Str` +* idnsforwardpolicy : :ref:`StrEnum` + * Values: ('only', 'first', 'none') +* timelimit : :ref:`Int` +* sizelimit : :ref:`Int` +* version : :ref:`Str` +* pkey_only : :ref:`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 \ No newline at end of file diff --git a/doc/api/dnsforwardzone_mod.md b/doc/api/dnsforwardzone_mod.md new file mode 100644 index 000000000..90c43dc87 --- /dev/null +++ b/doc/api/dnsforwardzone_mod.md @@ -0,0 +1,38 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# dnsforwardzone_mod +Modify DNS forward zone. + +### Arguments +|Name|Type|Required +|-|-|- +|idnsname|:ref:`DNSNameParam`|True + +### Options +* rights : :ref:`Flag` **(Required)** + * Default: False +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* name_from_ip : :ref:`Str` +* idnsforwarders : :ref:`Str` +* idnsforwardpolicy : :ref:`StrEnum` + * Values: ('only', 'first', 'none') +* setattr : :ref:`Str` +* addattr : :ref:`Str` +* delattr : :ref:`Str` +* version : :ref:`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 \ No newline at end of file diff --git a/doc/api/dnsforwardzone_remove_permission.md b/doc/api/dnsforwardzone_remove_permission.md new file mode 100644 index 000000000..e3b54ae16 --- /dev/null +++ b/doc/api/dnsforwardzone_remove_permission.md @@ -0,0 +1,25 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# dnsforwardzone_remove_permission +Remove a permission for per-forward zone access delegation. + +### Arguments +|Name|Type|Required +|-|-|- +|idnsname|:ref:`DNSNameParam`|True + +### Options +* version : :ref:`Str` + +### Output +|Name|Type +|-|- +|result|Output +|summary|Output +|value|Output + +[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end) +### Semantics + +### Notes + +### Version differences \ No newline at end of file diff --git a/doc/api/dnsforwardzone_show.md b/doc/api/dnsforwardzone_show.md new file mode 100644 index 000000000..f88ad2bcd --- /dev/null +++ b/doc/api/dnsforwardzone_show.md @@ -0,0 +1,31 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# dnsforwardzone_show +Display information about a DNS forward zone. + +### Arguments +|Name|Type|Required +|-|-|- +|idnsname|:ref:`DNSNameParam`|True + +### Options +* rights : :ref:`Flag` **(Required)** + * Default: False +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* version : :ref:`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 \ No newline at end of file diff --git a/doc/api/dnsrecord_add.md b/doc/api/dnsrecord_add.md new file mode 100644 index 000000000..3ce34db57 --- /dev/null +++ b/doc/api/dnsrecord_add.md @@ -0,0 +1,133 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# dnsrecord_add +Add new DNS resource record. + +### Arguments +|Name|Type|Required +|-|-|- +|dnszoneidnsname|:ref:`DNSNameParam`|True +|idnsname|:ref:`DNSNameParam`|True + +### Options +* force : :ref:`Flag` **(Required)** + * Default: False +* structured : :ref:`Flag` **(Required)** + * Default: False +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* dnsttl : :ref:`Int` +* dnsclass : :ref:`StrEnum` + * Values: ('IN', 'CS', 'CH', 'HS') +* arecord : :ref:`ARecord` +* a_part_ip_address : :ref:`Str` +* a_extra_create_reverse : :ref:`Flag` + * Default: False +* aaaarecord : :ref:`AAAARecord` +* aaaa_part_ip_address : :ref:`Str` +* aaaa_extra_create_reverse : :ref:`Flag` + * Default: False +* a6record : :ref:`A6Record` +* a6_part_data : :ref:`Str` +* afsdbrecord : :ref:`AFSDBRecord` +* afsdb_part_subtype : :ref:`Int` +* afsdb_part_hostname : :ref:`DNSNameParam` +* aplrecord : :ref:`APLRecord` +* certrecord : :ref:`CERTRecord` +* cert_part_type : :ref:`Int` +* cert_part_key_tag : :ref:`Int` +* cert_part_algorithm : :ref:`Int` +* cert_part_certificate_or_crl : :ref:`Str` +* cnamerecord : :ref:`CNAMERecord` +* cname_part_hostname : :ref:`DNSNameParam` +* dhcidrecord : :ref:`DHCIDRecord` +* dlvrecord : :ref:`DLVRecord` +* dlv_part_key_tag : :ref:`Int` +* dlv_part_algorithm : :ref:`Int` +* dlv_part_digest_type : :ref:`Int` +* dlv_part_digest : :ref:`Str` +* dnamerecord : :ref:`DNAMERecord` +* dname_part_target : :ref:`DNSNameParam` +* dsrecord : :ref:`DSRecord` +* ds_part_key_tag : :ref:`Int` +* ds_part_algorithm : :ref:`Int` +* ds_part_digest_type : :ref:`Int` +* ds_part_digest : :ref:`Str` +* hiprecord : :ref:`HIPRecord` +* ipseckeyrecord : :ref:`IPSECKEYRecord` +* keyrecord : :ref:`KEYRecord` +* kxrecord : :ref:`KXRecord` +* kx_part_preference : :ref:`Int` +* kx_part_exchanger : :ref:`DNSNameParam` +* locrecord : :ref:`LOCRecord` +* loc_part_lat_deg : :ref:`Int` +* loc_part_lat_min : :ref:`Int` +* loc_part_lat_sec : :ref:`Decimal` +* loc_part_lat_dir : :ref:`StrEnum` + * Values: ('N', 'S') +* loc_part_lon_deg : :ref:`Int` +* loc_part_lon_min : :ref:`Int` +* loc_part_lon_sec : :ref:`Decimal` +* loc_part_lon_dir : :ref:`StrEnum` + * Values: ('E', 'W') +* loc_part_altitude : :ref:`Decimal` +* loc_part_size : :ref:`Decimal` +* loc_part_h_precision : :ref:`Decimal` +* loc_part_v_precision : :ref:`Decimal` +* mxrecord : :ref:`MXRecord` +* mx_part_preference : :ref:`Int` +* mx_part_exchanger : :ref:`DNSNameParam` +* naptrrecord : :ref:`NAPTRRecord` +* naptr_part_order : :ref:`Int` +* naptr_part_preference : :ref:`Int` +* naptr_part_flags : :ref:`Str` +* naptr_part_service : :ref:`Str` +* naptr_part_regexp : :ref:`Str` +* naptr_part_replacement : :ref:`Str` +* nsrecord : :ref:`NSRecord` +* ns_part_hostname : :ref:`DNSNameParam` +* nsecrecord : :ref:`NSECRecord` +* ptrrecord : :ref:`PTRRecord` +* ptr_part_hostname : :ref:`DNSNameParam` +* rrsigrecord : :ref:`RRSIGRecord` +* rprecord : :ref:`RPRecord` +* sigrecord : :ref:`SIGRecord` +* spfrecord : :ref:`SPFRecord` +* srvrecord : :ref:`SRVRecord` +* srv_part_priority : :ref:`Int` +* srv_part_weight : :ref:`Int` +* srv_part_port : :ref:`Int` +* srv_part_target : :ref:`DNSNameParam` +* sshfprecord : :ref:`SSHFPRecord` +* sshfp_part_algorithm : :ref:`Int` +* sshfp_part_fp_type : :ref:`Int` +* sshfp_part_fingerprint : :ref:`Str` +* tlsarecord : :ref:`TLSARecord` +* tlsa_part_cert_usage : :ref:`Int` +* tlsa_part_selector : :ref:`Int` +* tlsa_part_matching_type : :ref:`Int` +* tlsa_part_cert_association_data : :ref:`Str` +* txtrecord : :ref:`TXTRecord` +* txt_part_data : :ref:`Str` +* urirecord : :ref:`URIRecord` +* uri_part_priority : :ref:`Int` +* uri_part_weight : :ref:`Int` +* uri_part_target : :ref:`Str` +* setattr : :ref:`Str` +* addattr : :ref:`Str` +* version : :ref:`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 \ No newline at end of file diff --git a/doc/api/dnsrecord_del.md b/doc/api/dnsrecord_del.md new file mode 100644 index 000000000..4ee2f581b --- /dev/null +++ b/doc/api/dnsrecord_del.md @@ -0,0 +1,65 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# dnsrecord_del +Delete DNS resource record. + +### Arguments +|Name|Type|Required +|-|-|- +|dnszoneidnsname|:ref:`DNSNameParam`|True +|idnsname|:ref:`DNSNameParam`|True + +### Options +* del_all : :ref:`Flag` **(Required)** + * Default: False +* structured : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* dnsttl : :ref:`Int` +* dnsclass : :ref:`StrEnum` + * Values: ('IN', 'CS', 'CH', 'HS') +* arecord : :ref:`ARecord` +* aaaarecord : :ref:`AAAARecord` +* a6record : :ref:`A6Record` +* afsdbrecord : :ref:`AFSDBRecord` +* aplrecord : :ref:`APLRecord` +* certrecord : :ref:`CERTRecord` +* cnamerecord : :ref:`CNAMERecord` +* dhcidrecord : :ref:`DHCIDRecord` +* dlvrecord : :ref:`DLVRecord` +* dnamerecord : :ref:`DNAMERecord` +* dsrecord : :ref:`DSRecord` +* hiprecord : :ref:`HIPRecord` +* ipseckeyrecord : :ref:`IPSECKEYRecord` +* keyrecord : :ref:`KEYRecord` +* kxrecord : :ref:`KXRecord` +* locrecord : :ref:`LOCRecord` +* mxrecord : :ref:`MXRecord` +* naptrrecord : :ref:`NAPTRRecord` +* nsrecord : :ref:`NSRecord` +* nsecrecord : :ref:`NSECRecord` +* ptrrecord : :ref:`PTRRecord` +* rrsigrecord : :ref:`RRSIGRecord` +* rprecord : :ref:`RPRecord` +* sigrecord : :ref:`SIGRecord` +* spfrecord : :ref:`SPFRecord` +* srvrecord : :ref:`SRVRecord` +* sshfprecord : :ref:`SSHFPRecord` +* tlsarecord : :ref:`TLSARecord` +* txtrecord : :ref:`TXTRecord` +* urirecord : :ref:`URIRecord` +* version : :ref:`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 \ No newline at end of file diff --git a/doc/api/dnsrecord_delentry.md b/doc/api/dnsrecord_delentry.md new file mode 100644 index 000000000..327269fa3 --- /dev/null +++ b/doc/api/dnsrecord_delentry.md @@ -0,0 +1,28 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# dnsrecord_delentry +Delete DNS record entry. + +### Arguments +|Name|Type|Required +|-|-|- +|dnszoneidnsname|:ref:`DNSNameParam`|True +|idnsname|:ref:`DNSNameParam`|True + +### Options +* continue : :ref:`Flag` **(Required)** + * Default: False +* version : :ref:`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 \ No newline at end of file diff --git a/doc/api/dnsrecord_find.md b/doc/api/dnsrecord_find.md new file mode 100644 index 000000000..242866ab4 --- /dev/null +++ b/doc/api/dnsrecord_find.md @@ -0,0 +1,71 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# dnsrecord_find +Search for DNS resources. + +### Arguments +|Name|Type|Required +|-|-|- +|dnszoneidnsname|:ref:`DNSNameParam`|True +|criteria|:ref:`Str`|False + +### Options +* structured : :ref:`Flag` **(Required)** + * Default: False +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* idnsname : :ref:`DNSNameParam` +* dnsttl : :ref:`Int` +* dnsclass : :ref:`StrEnum` + * Values: ('IN', 'CS', 'CH', 'HS') +* arecord : :ref:`ARecord` +* aaaarecord : :ref:`AAAARecord` +* a6record : :ref:`A6Record` +* afsdbrecord : :ref:`AFSDBRecord` +* aplrecord : :ref:`APLRecord` +* certrecord : :ref:`CERTRecord` +* cnamerecord : :ref:`CNAMERecord` +* dhcidrecord : :ref:`DHCIDRecord` +* dlvrecord : :ref:`DLVRecord` +* dnamerecord : :ref:`DNAMERecord` +* dsrecord : :ref:`DSRecord` +* hiprecord : :ref:`HIPRecord` +* ipseckeyrecord : :ref:`IPSECKEYRecord` +* keyrecord : :ref:`KEYRecord` +* kxrecord : :ref:`KXRecord` +* locrecord : :ref:`LOCRecord` +* mxrecord : :ref:`MXRecord` +* naptrrecord : :ref:`NAPTRRecord` +* nsrecord : :ref:`NSRecord` +* nsecrecord : :ref:`NSECRecord` +* ptrrecord : :ref:`PTRRecord` +* rrsigrecord : :ref:`RRSIGRecord` +* rprecord : :ref:`RPRecord` +* sigrecord : :ref:`SIGRecord` +* spfrecord : :ref:`SPFRecord` +* srvrecord : :ref:`SRVRecord` +* sshfprecord : :ref:`SSHFPRecord` +* tlsarecord : :ref:`TLSARecord` +* txtrecord : :ref:`TXTRecord` +* urirecord : :ref:`URIRecord` +* timelimit : :ref:`Int` +* sizelimit : :ref:`Int` +* version : :ref:`Str` +* pkey_only : :ref:`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 \ No newline at end of file diff --git a/doc/api/dnsrecord_mod.md b/doc/api/dnsrecord_mod.md new file mode 100644 index 000000000..c2675d7a1 --- /dev/null +++ b/doc/api/dnsrecord_mod.md @@ -0,0 +1,131 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# dnsrecord_mod +Modify a DNS resource record. + +### Arguments +|Name|Type|Required +|-|-|- +|dnszoneidnsname|:ref:`DNSNameParam`|True +|idnsname|:ref:`DNSNameParam`|True + +### Options +* rights : :ref:`Flag` **(Required)** + * Default: False +* structured : :ref:`Flag` **(Required)** + * Default: False +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* dnsttl : :ref:`Int` +* dnsclass : :ref:`StrEnum` + * Values: ('IN', 'CS', 'CH', 'HS') +* arecord : :ref:`ARecord` +* a_part_ip_address : :ref:`Str` +* aaaarecord : :ref:`AAAARecord` +* aaaa_part_ip_address : :ref:`Str` +* a6record : :ref:`A6Record` +* a6_part_data : :ref:`Str` +* afsdbrecord : :ref:`AFSDBRecord` +* afsdb_part_subtype : :ref:`Int` +* afsdb_part_hostname : :ref:`DNSNameParam` +* aplrecord : :ref:`APLRecord` +* certrecord : :ref:`CERTRecord` +* cert_part_type : :ref:`Int` +* cert_part_key_tag : :ref:`Int` +* cert_part_algorithm : :ref:`Int` +* cert_part_certificate_or_crl : :ref:`Str` +* cnamerecord : :ref:`CNAMERecord` +* cname_part_hostname : :ref:`DNSNameParam` +* dhcidrecord : :ref:`DHCIDRecord` +* dlvrecord : :ref:`DLVRecord` +* dlv_part_key_tag : :ref:`Int` +* dlv_part_algorithm : :ref:`Int` +* dlv_part_digest_type : :ref:`Int` +* dlv_part_digest : :ref:`Str` +* dnamerecord : :ref:`DNAMERecord` +* dname_part_target : :ref:`DNSNameParam` +* dsrecord : :ref:`DSRecord` +* ds_part_key_tag : :ref:`Int` +* ds_part_algorithm : :ref:`Int` +* ds_part_digest_type : :ref:`Int` +* ds_part_digest : :ref:`Str` +* hiprecord : :ref:`HIPRecord` +* ipseckeyrecord : :ref:`IPSECKEYRecord` +* keyrecord : :ref:`KEYRecord` +* kxrecord : :ref:`KXRecord` +* kx_part_preference : :ref:`Int` +* kx_part_exchanger : :ref:`DNSNameParam` +* locrecord : :ref:`LOCRecord` +* loc_part_lat_deg : :ref:`Int` +* loc_part_lat_min : :ref:`Int` +* loc_part_lat_sec : :ref:`Decimal` +* loc_part_lat_dir : :ref:`StrEnum` + * Values: ('N', 'S') +* loc_part_lon_deg : :ref:`Int` +* loc_part_lon_min : :ref:`Int` +* loc_part_lon_sec : :ref:`Decimal` +* loc_part_lon_dir : :ref:`StrEnum` + * Values: ('E', 'W') +* loc_part_altitude : :ref:`Decimal` +* loc_part_size : :ref:`Decimal` +* loc_part_h_precision : :ref:`Decimal` +* loc_part_v_precision : :ref:`Decimal` +* mxrecord : :ref:`MXRecord` +* mx_part_preference : :ref:`Int` +* mx_part_exchanger : :ref:`DNSNameParam` +* naptrrecord : :ref:`NAPTRRecord` +* naptr_part_order : :ref:`Int` +* naptr_part_preference : :ref:`Int` +* naptr_part_flags : :ref:`Str` +* naptr_part_service : :ref:`Str` +* naptr_part_regexp : :ref:`Str` +* naptr_part_replacement : :ref:`Str` +* nsrecord : :ref:`NSRecord` +* ns_part_hostname : :ref:`DNSNameParam` +* nsecrecord : :ref:`NSECRecord` +* ptrrecord : :ref:`PTRRecord` +* ptr_part_hostname : :ref:`DNSNameParam` +* rrsigrecord : :ref:`RRSIGRecord` +* rprecord : :ref:`RPRecord` +* sigrecord : :ref:`SIGRecord` +* spfrecord : :ref:`SPFRecord` +* srvrecord : :ref:`SRVRecord` +* srv_part_priority : :ref:`Int` +* srv_part_weight : :ref:`Int` +* srv_part_port : :ref:`Int` +* srv_part_target : :ref:`DNSNameParam` +* sshfprecord : :ref:`SSHFPRecord` +* sshfp_part_algorithm : :ref:`Int` +* sshfp_part_fp_type : :ref:`Int` +* sshfp_part_fingerprint : :ref:`Str` +* tlsarecord : :ref:`TLSARecord` +* tlsa_part_cert_usage : :ref:`Int` +* tlsa_part_selector : :ref:`Int` +* tlsa_part_matching_type : :ref:`Int` +* tlsa_part_cert_association_data : :ref:`Str` +* txtrecord : :ref:`TXTRecord` +* txt_part_data : :ref:`Str` +* urirecord : :ref:`URIRecord` +* uri_part_priority : :ref:`Int` +* uri_part_weight : :ref:`Int` +* uri_part_target : :ref:`Str` +* setattr : :ref:`Str` +* addattr : :ref:`Str` +* delattr : :ref:`Str` +* version : :ref:`Str` +* rename : :ref:`DNSNameParam` + +### 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 \ No newline at end of file diff --git a/doc/api/dnsrecord_show.md b/doc/api/dnsrecord_show.md new file mode 100644 index 000000000..4bdd8b8c7 --- /dev/null +++ b/doc/api/dnsrecord_show.md @@ -0,0 +1,34 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# dnsrecord_show +Display DNS resource. + +### Arguments +|Name|Type|Required +|-|-|- +|dnszoneidnsname|:ref:`DNSNameParam`|True +|idnsname|:ref:`DNSNameParam`|True + +### Options +* rights : :ref:`Flag` **(Required)** + * Default: False +* structured : :ref:`Flag` **(Required)** + * Default: False +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* version : :ref:`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 \ No newline at end of file diff --git a/doc/api/dnsrecord_split_parts.md b/doc/api/dnsrecord_split_parts.md new file mode 100644 index 000000000..d64166e4a --- /dev/null +++ b/doc/api/dnsrecord_split_parts.md @@ -0,0 +1,24 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# dnsrecord_split_parts +Split DNS record to parts + +### Arguments +|Name|Type|Required +|-|-|- +|name|:ref:`Str`|True +|value|:ref:`Str`|True + +### Options +* version : :ref:`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 \ No newline at end of file diff --git a/doc/api/dnsserver_add.md b/doc/api/dnsserver_add.md new file mode 100644 index 000000000..c665a8b12 --- /dev/null +++ b/doc/api/dnsserver_add.md @@ -0,0 +1,35 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# dnsserver_add +Add a new DNS server. + +### Arguments +|Name|Type|Required +|-|-|- +|idnsserverid|:ref:`Str`|True + +### Options +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* idnssoamname : :ref:`DNSNameParam` +* idnsforwarders : :ref:`Str` +* idnsforwardpolicy : :ref:`StrEnum` + * Values: ('only', 'first', 'none') +* setattr : :ref:`Str` +* addattr : :ref:`Str` +* version : :ref:`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 \ No newline at end of file diff --git a/doc/api/dnsserver_del.md b/doc/api/dnsserver_del.md new file mode 100644 index 000000000..614a0b015 --- /dev/null +++ b/doc/api/dnsserver_del.md @@ -0,0 +1,27 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# dnsserver_del +Delete a DNS server + +### Arguments +|Name|Type|Required +|-|-|- +|idnsserverid|:ref:`Str`|True + +### Options +* continue : :ref:`Flag` **(Required)** + * Default: False +* version : :ref:`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 \ No newline at end of file diff --git a/doc/api/dnsserver_find.md b/doc/api/dnsserver_find.md new file mode 100644 index 000000000..16d6d01d2 --- /dev/null +++ b/doc/api/dnsserver_find.md @@ -0,0 +1,39 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# dnsserver_find +Search for DNS servers. + +### Arguments +|Name|Type|Required +|-|-|- +|criteria|:ref:`Str`|False + +### Options +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* idnsserverid : :ref:`Str` +* idnssoamname : :ref:`DNSNameParam` +* idnsforwarders : :ref:`Str` +* idnsforwardpolicy : :ref:`StrEnum` + * Values: ('only', 'first', 'none') +* timelimit : :ref:`Int` +* sizelimit : :ref:`Int` +* version : :ref:`Str` +* pkey_only : :ref:`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 \ No newline at end of file diff --git a/doc/api/dnsserver_mod.md b/doc/api/dnsserver_mod.md new file mode 100644 index 000000000..a1480246e --- /dev/null +++ b/doc/api/dnsserver_mod.md @@ -0,0 +1,38 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# dnsserver_mod +Modify DNS server configuration + +### Arguments +|Name|Type|Required +|-|-|- +|idnsserverid|:ref:`Str`|True + +### Options +* rights : :ref:`Flag` **(Required)** + * Default: False +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* idnssoamname : :ref:`DNSNameParam` +* idnsforwarders : :ref:`Str` +* idnsforwardpolicy : :ref:`StrEnum` + * Values: ('only', 'first', 'none') +* setattr : :ref:`Str` +* addattr : :ref:`Str` +* delattr : :ref:`Str` +* version : :ref:`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 \ No newline at end of file diff --git a/doc/api/dnsserver_show.md b/doc/api/dnsserver_show.md new file mode 100644 index 000000000..20aeb11c6 --- /dev/null +++ b/doc/api/dnsserver_show.md @@ -0,0 +1,31 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# dnsserver_show +Display configuration of a DNS server. + +### Arguments +|Name|Type|Required +|-|-|- +|idnsserverid|:ref:`Str`|True + +### Options +* rights : :ref:`Flag` **(Required)** + * Default: False +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* version : :ref:`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 \ No newline at end of file diff --git a/doc/api/dnszone_add.md b/doc/api/dnszone_add.md new file mode 100644 index 000000000..2b23dc9ec --- /dev/null +++ b/doc/api/dnszone_add.md @@ -0,0 +1,69 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# dnszone_add +Create new DNS zone (SOA record). + +### Arguments +|Name|Type|Required +|-|-|- +|idnsname|:ref:`DNSNameParam`|True + +### Options +* idnssoarname : :ref:`DNSNameParam` **(Required)** + * Default: hostmaster +* idnssoaserial : :ref:`Int` **(Required)** +* idnssoarefresh : :ref:`Int` **(Required)** + * Default: 3600 +* idnssoaretry : :ref:`Int` **(Required)** + * Default: 900 +* idnssoaexpire : :ref:`Int` **(Required)** + * Default: 1209600 +* idnssoaminimum : :ref:`Int` **(Required)** + * Default: 3600 +* skip_overlap_check : :ref:`Flag` **(Required)** + * Default: False +* force : :ref:`Flag` **(Required)** + * Default: False +* skip_nameserver_check : :ref:`Flag` **(Required)** + * Default: False +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* name_from_ip : :ref:`Str` +* idnsforwarders : :ref:`Str` +* idnsforwardpolicy : :ref:`StrEnum` + * Values: ('only', 'first', 'none') +* idnssoamname : :ref:`DNSNameParam` +* dnsttl : :ref:`Int` +* dnsdefaultttl : :ref:`Int` +* dnsclass : :ref:`StrEnum` + * Values: ('IN', 'CS', 'CH', 'HS') +* idnsupdatepolicy : :ref:`Str` +* idnsallowdynupdate : :ref:`Bool` + * Default: False +* idnsallowquery : :ref:`Str` + * Default: any; +* idnsallowtransfer : :ref:`Str` + * Default: none; +* idnsallowsyncptr : :ref:`Bool` +* idnssecinlinesigning : :ref:`Bool` + * Default: False +* nsec3paramrecord : :ref:`Str` +* setattr : :ref:`Str` +* addattr : :ref:`Str` +* ip_address : :ref:`Str` +* version : :ref:`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 \ No newline at end of file diff --git a/doc/api/dnszone_add_permission.md b/doc/api/dnszone_add_permission.md new file mode 100644 index 000000000..8af0c958e --- /dev/null +++ b/doc/api/dnszone_add_permission.md @@ -0,0 +1,25 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# dnszone_add_permission +Add a permission for per-zone access delegation. + +### Arguments +|Name|Type|Required +|-|-|- +|idnsname|:ref:`DNSNameParam`|True + +### Options +* version : :ref:`Str` + +### Output +|Name|Type +|-|- +|result|Output +|summary|Output +|value|Output + +[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end) +### Semantics + +### Notes + +### Version differences \ No newline at end of file diff --git a/doc/api/dnszone_del.md b/doc/api/dnszone_del.md new file mode 100644 index 000000000..c317cb515 --- /dev/null +++ b/doc/api/dnszone_del.md @@ -0,0 +1,27 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# dnszone_del +Delete DNS zone (SOA record). + +### Arguments +|Name|Type|Required +|-|-|- +|idnsname|:ref:`DNSNameParam`|True + +### Options +* continue : :ref:`Flag` **(Required)** + * Default: False +* version : :ref:`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 \ No newline at end of file diff --git a/doc/api/dnszone_disable.md b/doc/api/dnszone_disable.md new file mode 100644 index 000000000..922f70085 --- /dev/null +++ b/doc/api/dnszone_disable.md @@ -0,0 +1,25 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# dnszone_disable +Disable DNS Zone. + +### Arguments +|Name|Type|Required +|-|-|- +|idnsname|:ref:`DNSNameParam`|True + +### Options +* version : :ref:`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 \ No newline at end of file diff --git a/doc/api/dnszone_enable.md b/doc/api/dnszone_enable.md new file mode 100644 index 000000000..4e565d61a --- /dev/null +++ b/doc/api/dnszone_enable.md @@ -0,0 +1,25 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# dnszone_enable +Enable DNS Zone. + +### Arguments +|Name|Type|Required +|-|-|- +|idnsname|:ref:`DNSNameParam`|True + +### Options +* version : :ref:`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 \ No newline at end of file diff --git a/doc/api/dnszone_find.md b/doc/api/dnszone_find.md new file mode 100644 index 000000000..db2e6bbc3 --- /dev/null +++ b/doc/api/dnszone_find.md @@ -0,0 +1,69 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# dnszone_find +Search for DNS zones (SOA records). + +### Arguments +|Name|Type|Required +|-|-|- +|criteria|:ref:`Str`|False + +### Options +* forward_only : :ref:`Flag` **(Required)** + * Default: False +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* idnsname : :ref:`DNSNameParam` +* name_from_ip : :ref:`Str` +* idnszoneactive : :ref:`Bool` +* idnsforwarders : :ref:`Str` +* idnsforwardpolicy : :ref:`StrEnum` + * Values: ('only', 'first', 'none') +* idnssoamname : :ref:`DNSNameParam` +* idnssoarname : :ref:`DNSNameParam` + * Default: hostmaster +* idnssoaserial : :ref:`Int` +* idnssoarefresh : :ref:`Int` + * Default: 3600 +* idnssoaretry : :ref:`Int` + * Default: 900 +* idnssoaexpire : :ref:`Int` + * Default: 1209600 +* idnssoaminimum : :ref:`Int` + * Default: 3600 +* dnsttl : :ref:`Int` +* dnsdefaultttl : :ref:`Int` +* dnsclass : :ref:`StrEnum` + * Values: ('IN', 'CS', 'CH', 'HS') +* idnsupdatepolicy : :ref:`Str` +* idnsallowdynupdate : :ref:`Bool` + * Default: False +* idnsallowquery : :ref:`Str` + * Default: any; +* idnsallowtransfer : :ref:`Str` + * Default: none; +* idnsallowsyncptr : :ref:`Bool` +* idnssecinlinesigning : :ref:`Bool` + * Default: False +* nsec3paramrecord : :ref:`Str` +* timelimit : :ref:`Int` +* sizelimit : :ref:`Int` +* version : :ref:`Str` +* pkey_only : :ref:`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 \ No newline at end of file diff --git a/doc/api/dnszone_mod.md b/doc/api/dnszone_mod.md new file mode 100644 index 000000000..b0afc3633 --- /dev/null +++ b/doc/api/dnszone_mod.md @@ -0,0 +1,67 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# dnszone_mod +Modify DNS zone (SOA record). + +### Arguments +|Name|Type|Required +|-|-|- +|idnsname|:ref:`DNSNameParam`|True + +### Options +* rights : :ref:`Flag` **(Required)** + * Default: False +* force : :ref:`Flag` **(Required)** + * Default: False +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* name_from_ip : :ref:`Str` +* idnsforwarders : :ref:`Str` +* idnsforwardpolicy : :ref:`StrEnum` + * Values: ('only', 'first', 'none') +* idnssoamname : :ref:`DNSNameParam` +* idnssoarname : :ref:`DNSNameParam` + * Default: hostmaster +* idnssoaserial : :ref:`Int` +* idnssoarefresh : :ref:`Int` + * Default: 3600 +* idnssoaretry : :ref:`Int` + * Default: 900 +* idnssoaexpire : :ref:`Int` + * Default: 1209600 +* idnssoaminimum : :ref:`Int` + * Default: 3600 +* dnsttl : :ref:`Int` +* dnsdefaultttl : :ref:`Int` +* dnsclass : :ref:`StrEnum` + * Values: ('IN', 'CS', 'CH', 'HS') +* idnsupdatepolicy : :ref:`Str` +* idnsallowdynupdate : :ref:`Bool` + * Default: False +* idnsallowquery : :ref:`Str` + * Default: any; +* idnsallowtransfer : :ref:`Str` + * Default: none; +* idnsallowsyncptr : :ref:`Bool` +* idnssecinlinesigning : :ref:`Bool` + * Default: False +* nsec3paramrecord : :ref:`Str` +* setattr : :ref:`Str` +* addattr : :ref:`Str` +* delattr : :ref:`Str` +* version : :ref:`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 \ No newline at end of file diff --git a/doc/api/dnszone_remove_permission.md b/doc/api/dnszone_remove_permission.md new file mode 100644 index 000000000..8978e5ab2 --- /dev/null +++ b/doc/api/dnszone_remove_permission.md @@ -0,0 +1,25 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# dnszone_remove_permission +Remove a permission for per-zone access delegation. + +### Arguments +|Name|Type|Required +|-|-|- +|idnsname|:ref:`DNSNameParam`|True + +### Options +* version : :ref:`Str` + +### Output +|Name|Type +|-|- +|result|Output +|summary|Output +|value|Output + +[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end) +### Semantics + +### Notes + +### Version differences \ No newline at end of file diff --git a/doc/api/dnszone_show.md b/doc/api/dnszone_show.md new file mode 100644 index 000000000..965d61c62 --- /dev/null +++ b/doc/api/dnszone_show.md @@ -0,0 +1,31 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# dnszone_show +Display information about a DNS zone (SOA record). + +### Arguments +|Name|Type|Required +|-|-|- +|idnsname|:ref:`DNSNameParam`|True + +### Options +* rights : :ref:`Flag` **(Required)** + * Default: False +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* version : :ref:`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 \ No newline at end of file diff --git a/doc/api/domainlevel_get.md b/doc/api/domainlevel_get.md new file mode 100644 index 000000000..25b428e22 --- /dev/null +++ b/doc/api/domainlevel_get.md @@ -0,0 +1,21 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# domainlevel_get +Query current Domain Level. + +### Arguments +No arguments. + +### Options +* version : :ref:`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 \ No newline at end of file diff --git a/doc/api/domainlevel_set.md b/doc/api/domainlevel_set.md new file mode 100644 index 000000000..3b6c94fdd --- /dev/null +++ b/doc/api/domainlevel_set.md @@ -0,0 +1,23 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# domainlevel_set +Change current Domain Level. + +### Arguments +|Name|Type|Required +|-|-|- +|ipadomainlevel|:ref:`Int`|True + +### Options +* version : :ref:`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 \ No newline at end of file diff --git a/doc/api/env.md b/doc/api/env.md new file mode 100644 index 000000000..fda7c8c29 --- /dev/null +++ b/doc/api/env.md @@ -0,0 +1,30 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# env +Show environment variables. + +### Arguments +|Name|Type|Required +|-|-|- +|variables|:ref:`Str`|False + +### Options +* all : :ref:`Flag` **(Required)** + * Default: True +* server : :ref:`Flag` + * Default: False +* version : :ref:`Str` + +### Output +|Name|Type +|-|- +|count|Output +|result|Output +|summary|Output +|total|Output + +[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end) +### Semantics + +### Notes + +### Version differences \ No newline at end of file diff --git a/doc/api/group_add.md b/doc/api/group_add.md new file mode 100644 index 000000000..fb46835b5 --- /dev/null +++ b/doc/api/group_add.md @@ -0,0 +1,39 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# group_add +Create a new group. + +### Arguments +|Name|Type|Required +|-|-|- +|cn|:ref:`Str`|True + +### Options +* nonposix : :ref:`Flag` **(Required)** + * Default: False +* external : :ref:`Flag` **(Required)** + * Default: False +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* no_members : :ref:`Flag` **(Required)** + * Default: False +* description : :ref:`Str` +* gidnumber : :ref:`Int` +* setattr : :ref:`Str` +* addattr : :ref:`Str` +* version : :ref:`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 \ No newline at end of file diff --git a/doc/api/group_add_member.md b/doc/api/group_add_member.md new file mode 100644 index 000000000..f84ec9417 --- /dev/null +++ b/doc/api/group_add_member.md @@ -0,0 +1,36 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# group_add_member +Add members to a group. + +### Arguments +|Name|Type|Required +|-|-|- +|cn|:ref:`Str`|True + +### Options +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* no_members : :ref:`Flag` **(Required)** + * Default: False +* ipaexternalmember : :ref:`Str` +* version : :ref:`Str` +* user : :ref:`Str` +* group : :ref:`Str` +* service : :ref:`Str` +* idoverrideuser : :ref:`Str` + +### Output +|Name|Type +|-|- +|completed|Output +|failed|Output +|result|Entry + +[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end) +### Semantics + +### Notes + +### Version differences \ No newline at end of file diff --git a/doc/api/group_add_member_manager.md b/doc/api/group_add_member_manager.md new file mode 100644 index 000000000..165aede6a --- /dev/null +++ b/doc/api/group_add_member_manager.md @@ -0,0 +1,33 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# group_add_member_manager +Add users that can manage members of this group. + +### Arguments +|Name|Type|Required +|-|-|- +|cn|:ref:`Str`|True + +### Options +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* no_members : :ref:`Flag` **(Required)** + * Default: False +* version : :ref:`Str` +* user : :ref:`Str` +* group : :ref:`Str` + +### Output +|Name|Type +|-|- +|completed|Output +|failed|Output +|result|Entry + +[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end) +### Semantics + +### Notes + +### Version differences \ No newline at end of file diff --git a/doc/api/group_del.md b/doc/api/group_del.md new file mode 100644 index 000000000..0b9ff392d --- /dev/null +++ b/doc/api/group_del.md @@ -0,0 +1,27 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# group_del +Delete group. + +### Arguments +|Name|Type|Required +|-|-|- +|cn|:ref:`Str`|True + +### Options +* continue : :ref:`Flag` **(Required)** + * Default: False +* version : :ref:`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 \ No newline at end of file diff --git a/doc/api/group_detach.md b/doc/api/group_detach.md new file mode 100644 index 000000000..c34b91c65 --- /dev/null +++ b/doc/api/group_detach.md @@ -0,0 +1,25 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# group_detach +Detach a managed group from a user. + +### Arguments +|Name|Type|Required +|-|-|- +|cn|:ref:`Str`|True + +### Options +* version : :ref:`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 \ No newline at end of file diff --git a/doc/api/group_find.md b/doc/api/group_find.md new file mode 100644 index 000000000..bd4a442c0 --- /dev/null +++ b/doc/api/group_find.md @@ -0,0 +1,69 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# group_find +Search for groups. + +### Arguments +|Name|Type|Required +|-|-|- +|criteria|:ref:`Str`|False + +### Options +* private : :ref:`Flag` **(Required)** + * Default: False +* posix : :ref:`Flag` **(Required)** + * Default: False +* external : :ref:`Flag` **(Required)** + * Default: False +* nonposix : :ref:`Flag` **(Required)** + * Default: False +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* no_members : :ref:`Flag` **(Required)** + * Default: True +* cn : :ref:`Str` +* description : :ref:`Str` +* gidnumber : :ref:`Int` +* timelimit : :ref:`Int` +* sizelimit : :ref:`Int` +* version : :ref:`Str` +* pkey_only : :ref:`Flag` + * Default: False +* user : :ref:`Str` +* no_user : :ref:`Str` +* group : :ref:`Str` +* no_group : :ref:`Str` +* service : :ref:`Principal` +* no_service : :ref:`Principal` +* idoverrideuser : :ref:`Str` +* no_idoverrideuser : :ref:`Str` +* in_group : :ref:`Str` +* not_in_group : :ref:`Str` +* in_netgroup : :ref:`Str` +* not_in_netgroup : :ref:`Str` +* in_role : :ref:`Str` +* not_in_role : :ref:`Str` +* in_hbacrule : :ref:`Str` +* not_in_hbacrule : :ref:`Str` +* in_sudorule : :ref:`Str` +* not_in_sudorule : :ref:`Str` +* membermanager_user : :ref:`Str` +* not_membermanager_user : :ref:`Str` +* membermanager_group : :ref:`Str` +* not_membermanager_group : :ref:`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 \ No newline at end of file diff --git a/doc/api/group_mod.md b/doc/api/group_mod.md new file mode 100644 index 000000000..1169706b9 --- /dev/null +++ b/doc/api/group_mod.md @@ -0,0 +1,43 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# group_mod +Modify a group. + +### Arguments +|Name|Type|Required +|-|-|- +|cn|:ref:`Str`|True + +### Options +* rights : :ref:`Flag` **(Required)** + * Default: False +* posix : :ref:`Flag` **(Required)** + * Default: False +* external : :ref:`Flag` **(Required)** + * Default: False +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* no_members : :ref:`Flag` **(Required)** + * Default: False +* description : :ref:`Str` +* gidnumber : :ref:`Int` +* setattr : :ref:`Str` +* addattr : :ref:`Str` +* delattr : :ref:`Str` +* version : :ref:`Str` +* rename : :ref:`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 \ No newline at end of file diff --git a/doc/api/group_remove_member.md b/doc/api/group_remove_member.md new file mode 100644 index 000000000..2861f391f --- /dev/null +++ b/doc/api/group_remove_member.md @@ -0,0 +1,36 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# group_remove_member +Remove members from a group. + +### Arguments +|Name|Type|Required +|-|-|- +|cn|:ref:`Str`|True + +### Options +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* no_members : :ref:`Flag` **(Required)** + * Default: False +* ipaexternalmember : :ref:`Str` +* version : :ref:`Str` +* user : :ref:`Str` +* group : :ref:`Str` +* service : :ref:`Str` +* idoverrideuser : :ref:`Str` + +### Output +|Name|Type +|-|- +|completed|Output +|failed|Output +|result|Entry + +[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end) +### Semantics + +### Notes + +### Version differences \ No newline at end of file diff --git a/doc/api/group_remove_member_manager.md b/doc/api/group_remove_member_manager.md new file mode 100644 index 000000000..e893aa214 --- /dev/null +++ b/doc/api/group_remove_member_manager.md @@ -0,0 +1,33 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# group_remove_member_manager +Remove users that can manage members of this group. + +### Arguments +|Name|Type|Required +|-|-|- +|cn|:ref:`Str`|True + +### Options +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* no_members : :ref:`Flag` **(Required)** + * Default: False +* version : :ref:`Str` +* user : :ref:`Str` +* group : :ref:`Str` + +### Output +|Name|Type +|-|- +|completed|Output +|failed|Output +|result|Entry + +[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end) +### Semantics + +### Notes + +### Version differences \ No newline at end of file diff --git a/doc/api/group_show.md b/doc/api/group_show.md new file mode 100644 index 000000000..3bd504599 --- /dev/null +++ b/doc/api/group_show.md @@ -0,0 +1,33 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# group_show +Display information about a named group. + +### Arguments +|Name|Type|Required +|-|-|- +|cn|:ref:`Str`|True + +### Options +* rights : :ref:`Flag` **(Required)** + * Default: False +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* no_members : :ref:`Flag` **(Required)** + * Default: False +* version : :ref:`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 \ No newline at end of file diff --git a/doc/api/hbacrule_add.md b/doc/api/hbacrule_add.md new file mode 100644 index 000000000..2ffb569cd --- /dev/null +++ b/doc/api/hbacrule_add.md @@ -0,0 +1,47 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# hbacrule_add +Create a new HBAC rule. + +### Arguments +|Name|Type|Required +|-|-|- +|cn|:ref:`Str`|True + +### Options +* accessruletype : :ref:`StrEnum` **(Required)** + * Default: allow + * Values: ('allow', 'deny') +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* no_members : :ref:`Flag` **(Required)** + * Default: False +* usercategory : :ref:`StrEnum` + * Values: ('all',) +* hostcategory : :ref:`StrEnum` + * Values: ('all',) +* sourcehostcategory : :ref:`StrEnum` + * Values: ('all',) +* servicecategory : :ref:`StrEnum` + * Values: ('all',) +* description : :ref:`Str` +* ipaenabledflag : :ref:`Bool` +* externalhost : :ref:`Str` +* setattr : :ref:`Str` +* addattr : :ref:`Str` +* version : :ref:`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 \ No newline at end of file diff --git a/doc/api/hbacrule_add_host.md b/doc/api/hbacrule_add_host.md new file mode 100644 index 000000000..c5fbbbce6 --- /dev/null +++ b/doc/api/hbacrule_add_host.md @@ -0,0 +1,33 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# hbacrule_add_host +Add target hosts and hostgroups to an HBAC rule. + +### Arguments +|Name|Type|Required +|-|-|- +|cn|:ref:`Str`|True + +### Options +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* no_members : :ref:`Flag` **(Required)** + * Default: False +* version : :ref:`Str` +* host : :ref:`Str` +* hostgroup : :ref:`Str` + +### Output +|Name|Type +|-|- +|completed|Output +|failed|Output +|result|Entry + +[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end) +### Semantics + +### Notes + +### Version differences \ No newline at end of file diff --git a/doc/api/hbacrule_add_service.md b/doc/api/hbacrule_add_service.md new file mode 100644 index 000000000..6a53e9e20 --- /dev/null +++ b/doc/api/hbacrule_add_service.md @@ -0,0 +1,33 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# hbacrule_add_service +Add services to an HBAC rule. + +### Arguments +|Name|Type|Required +|-|-|- +|cn|:ref:`Str`|True + +### Options +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* no_members : :ref:`Flag` **(Required)** + * Default: False +* version : :ref:`Str` +* hbacsvc : :ref:`Str` +* hbacsvcgroup : :ref:`Str` + +### Output +|Name|Type +|-|- +|completed|Output +|failed|Output +|result|Entry + +[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end) +### Semantics + +### Notes + +### Version differences \ No newline at end of file diff --git a/doc/api/hbacrule_add_sourcehost.md b/doc/api/hbacrule_add_sourcehost.md new file mode 100644 index 000000000..e6c5d2800 --- /dev/null +++ b/doc/api/hbacrule_add_sourcehost.md @@ -0,0 +1,33 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# hbacrule_add_sourcehost +Add source hosts and hostgroups to an HBAC rule. + +### Arguments +|Name|Type|Required +|-|-|- +|cn|:ref:`Str`|True + +### Options +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* no_members : :ref:`Flag` **(Required)** + * Default: False +* version : :ref:`Str` +* host : :ref:`Str` +* hostgroup : :ref:`Str` + +### Output +|Name|Type +|-|- +|completed|Output +|failed|Output +|result|Entry + +[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end) +### Semantics + +### Notes + +### Version differences \ No newline at end of file diff --git a/doc/api/hbacrule_add_user.md b/doc/api/hbacrule_add_user.md new file mode 100644 index 000000000..63576465c --- /dev/null +++ b/doc/api/hbacrule_add_user.md @@ -0,0 +1,33 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# hbacrule_add_user +Add users and groups to an HBAC rule. + +### Arguments +|Name|Type|Required +|-|-|- +|cn|:ref:`Str`|True + +### Options +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* no_members : :ref:`Flag` **(Required)** + * Default: False +* version : :ref:`Str` +* user : :ref:`Str` +* group : :ref:`Str` + +### Output +|Name|Type +|-|- +|completed|Output +|failed|Output +|result|Entry + +[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end) +### Semantics + +### Notes + +### Version differences \ No newline at end of file diff --git a/doc/api/hbacrule_del.md b/doc/api/hbacrule_del.md new file mode 100644 index 000000000..bad8cf073 --- /dev/null +++ b/doc/api/hbacrule_del.md @@ -0,0 +1,27 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# hbacrule_del +Delete an HBAC rule. + +### Arguments +|Name|Type|Required +|-|-|- +|cn|:ref:`Str`|True + +### Options +* continue : :ref:`Flag` **(Required)** + * Default: False +* version : :ref:`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 \ No newline at end of file diff --git a/doc/api/hbacrule_disable.md b/doc/api/hbacrule_disable.md new file mode 100644 index 000000000..7f1286e73 --- /dev/null +++ b/doc/api/hbacrule_disable.md @@ -0,0 +1,25 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# hbacrule_disable +Disable an HBAC rule. + +### Arguments +|Name|Type|Required +|-|-|- +|cn|:ref:`Str`|True + +### Options +* version : :ref:`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 \ No newline at end of file diff --git a/doc/api/hbacrule_enable.md b/doc/api/hbacrule_enable.md new file mode 100644 index 000000000..cdd6f53e0 --- /dev/null +++ b/doc/api/hbacrule_enable.md @@ -0,0 +1,25 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# hbacrule_enable +Enable an HBAC rule. + +### Arguments +|Name|Type|Required +|-|-|- +|cn|:ref:`Str`|True + +### Options +* version : :ref:`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 \ No newline at end of file diff --git a/doc/api/hbacrule_find.md b/doc/api/hbacrule_find.md new file mode 100644 index 000000000..f79317c62 --- /dev/null +++ b/doc/api/hbacrule_find.md @@ -0,0 +1,51 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# hbacrule_find +Search for HBAC rules. + +### Arguments +|Name|Type|Required +|-|-|- +|criteria|:ref:`Str`|False + +### Options +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* no_members : :ref:`Flag` **(Required)** + * Default: True +* cn : :ref:`Str` +* accessruletype : :ref:`StrEnum` + * Default: allow + * Values: ('allow', 'deny') +* usercategory : :ref:`StrEnum` + * Values: ('all',) +* hostcategory : :ref:`StrEnum` + * Values: ('all',) +* sourcehostcategory : :ref:`StrEnum` + * Values: ('all',) +* servicecategory : :ref:`StrEnum` + * Values: ('all',) +* description : :ref:`Str` +* ipaenabledflag : :ref:`Bool` +* externalhost : :ref:`Str` +* timelimit : :ref:`Int` +* sizelimit : :ref:`Int` +* version : :ref:`Str` +* pkey_only : :ref:`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 \ No newline at end of file diff --git a/doc/api/hbacrule_mod.md b/doc/api/hbacrule_mod.md new file mode 100644 index 000000000..398ee2518 --- /dev/null +++ b/doc/api/hbacrule_mod.md @@ -0,0 +1,51 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# hbacrule_mod +Modify an HBAC rule. + +### Arguments +|Name|Type|Required +|-|-|- +|cn|:ref:`Str`|True + +### Options +* rights : :ref:`Flag` **(Required)** + * Default: False +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* no_members : :ref:`Flag` **(Required)** + * Default: False +* accessruletype : :ref:`StrEnum` + * Default: allow + * Values: ('allow', 'deny') +* usercategory : :ref:`StrEnum` + * Values: ('all',) +* hostcategory : :ref:`StrEnum` + * Values: ('all',) +* sourcehostcategory : :ref:`StrEnum` + * Values: ('all',) +* servicecategory : :ref:`StrEnum` + * Values: ('all',) +* description : :ref:`Str` +* ipaenabledflag : :ref:`Bool` +* externalhost : :ref:`Str` +* setattr : :ref:`Str` +* addattr : :ref:`Str` +* delattr : :ref:`Str` +* version : :ref:`Str` +* rename : :ref:`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 \ No newline at end of file diff --git a/doc/api/hbacrule_remove_host.md b/doc/api/hbacrule_remove_host.md new file mode 100644 index 000000000..417eddf1c --- /dev/null +++ b/doc/api/hbacrule_remove_host.md @@ -0,0 +1,33 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# hbacrule_remove_host +Remove target hosts and hostgroups from an HBAC rule. + +### Arguments +|Name|Type|Required +|-|-|- +|cn|:ref:`Str`|True + +### Options +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* no_members : :ref:`Flag` **(Required)** + * Default: False +* version : :ref:`Str` +* host : :ref:`Str` +* hostgroup : :ref:`Str` + +### Output +|Name|Type +|-|- +|completed|Output +|failed|Output +|result|Entry + +[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end) +### Semantics + +### Notes + +### Version differences \ No newline at end of file diff --git a/doc/api/hbacrule_remove_service.md b/doc/api/hbacrule_remove_service.md new file mode 100644 index 000000000..7afe9fbbc --- /dev/null +++ b/doc/api/hbacrule_remove_service.md @@ -0,0 +1,33 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# hbacrule_remove_service +Remove service and service groups from an HBAC rule. + +### Arguments +|Name|Type|Required +|-|-|- +|cn|:ref:`Str`|True + +### Options +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* no_members : :ref:`Flag` **(Required)** + * Default: False +* version : :ref:`Str` +* hbacsvc : :ref:`Str` +* hbacsvcgroup : :ref:`Str` + +### Output +|Name|Type +|-|- +|completed|Output +|failed|Output +|result|Entry + +[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end) +### Semantics + +### Notes + +### Version differences \ No newline at end of file diff --git a/doc/api/hbacrule_remove_sourcehost.md b/doc/api/hbacrule_remove_sourcehost.md new file mode 100644 index 000000000..479cf3bb0 --- /dev/null +++ b/doc/api/hbacrule_remove_sourcehost.md @@ -0,0 +1,33 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# hbacrule_remove_sourcehost +Remove source hosts and hostgroups from an HBAC rule. + +### Arguments +|Name|Type|Required +|-|-|- +|cn|:ref:`Str`|True + +### Options +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* no_members : :ref:`Flag` **(Required)** + * Default: False +* version : :ref:`Str` +* host : :ref:`Str` +* hostgroup : :ref:`Str` + +### Output +|Name|Type +|-|- +|completed|Output +|failed|Output +|result|Entry + +[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end) +### Semantics + +### Notes + +### Version differences \ No newline at end of file diff --git a/doc/api/hbacrule_remove_user.md b/doc/api/hbacrule_remove_user.md new file mode 100644 index 000000000..578607af7 --- /dev/null +++ b/doc/api/hbacrule_remove_user.md @@ -0,0 +1,33 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# hbacrule_remove_user +Remove users and groups from an HBAC rule. + +### Arguments +|Name|Type|Required +|-|-|- +|cn|:ref:`Str`|True + +### Options +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* no_members : :ref:`Flag` **(Required)** + * Default: False +* version : :ref:`Str` +* user : :ref:`Str` +* group : :ref:`Str` + +### Output +|Name|Type +|-|- +|completed|Output +|failed|Output +|result|Entry + +[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end) +### Semantics + +### Notes + +### Version differences \ No newline at end of file diff --git a/doc/api/hbacrule_show.md b/doc/api/hbacrule_show.md new file mode 100644 index 000000000..144d59368 --- /dev/null +++ b/doc/api/hbacrule_show.md @@ -0,0 +1,33 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# hbacrule_show +Display the properties of an HBAC rule. + +### Arguments +|Name|Type|Required +|-|-|- +|cn|:ref:`Str`|True + +### Options +* rights : :ref:`Flag` **(Required)** + * Default: False +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* no_members : :ref:`Flag` **(Required)** + * Default: False +* version : :ref:`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 \ No newline at end of file diff --git a/doc/api/hbacsvc_add.md b/doc/api/hbacsvc_add.md new file mode 100644 index 000000000..c493e94f1 --- /dev/null +++ b/doc/api/hbacsvc_add.md @@ -0,0 +1,34 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# hbacsvc_add +Add a new HBAC service. + +### Arguments +|Name|Type|Required +|-|-|- +|cn|:ref:`Str`|True + +### Options +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* no_members : :ref:`Flag` **(Required)** + * Default: False +* description : :ref:`Str` +* setattr : :ref:`Str` +* addattr : :ref:`Str` +* version : :ref:`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 \ No newline at end of file diff --git a/doc/api/hbacsvc_del.md b/doc/api/hbacsvc_del.md new file mode 100644 index 000000000..d4f7dcd73 --- /dev/null +++ b/doc/api/hbacsvc_del.md @@ -0,0 +1,27 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# hbacsvc_del +Delete an existing HBAC service. + +### Arguments +|Name|Type|Required +|-|-|- +|cn|:ref:`Str`|True + +### Options +* continue : :ref:`Flag` **(Required)** + * Default: False +* version : :ref:`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 \ No newline at end of file diff --git a/doc/api/hbacsvc_find.md b/doc/api/hbacsvc_find.md new file mode 100644 index 000000000..fe230e395 --- /dev/null +++ b/doc/api/hbacsvc_find.md @@ -0,0 +1,38 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# hbacsvc_find +Search for HBAC services. + +### Arguments +|Name|Type|Required +|-|-|- +|criteria|:ref:`Str`|False + +### Options +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* no_members : :ref:`Flag` **(Required)** + * Default: True +* cn : :ref:`Str` +* description : :ref:`Str` +* timelimit : :ref:`Int` +* sizelimit : :ref:`Int` +* version : :ref:`Str` +* pkey_only : :ref:`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 \ No newline at end of file diff --git a/doc/api/hbacsvc_mod.md b/doc/api/hbacsvc_mod.md new file mode 100644 index 000000000..894645093 --- /dev/null +++ b/doc/api/hbacsvc_mod.md @@ -0,0 +1,37 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# hbacsvc_mod +Modify an HBAC service. + +### Arguments +|Name|Type|Required +|-|-|- +|cn|:ref:`Str`|True + +### Options +* rights : :ref:`Flag` **(Required)** + * Default: False +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* no_members : :ref:`Flag` **(Required)** + * Default: False +* description : :ref:`Str` +* setattr : :ref:`Str` +* addattr : :ref:`Str` +* delattr : :ref:`Str` +* version : :ref:`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 \ No newline at end of file diff --git a/doc/api/hbacsvc_show.md b/doc/api/hbacsvc_show.md new file mode 100644 index 000000000..dd2b4acc9 --- /dev/null +++ b/doc/api/hbacsvc_show.md @@ -0,0 +1,33 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# hbacsvc_show +Display information about an HBAC service. + +### Arguments +|Name|Type|Required +|-|-|- +|cn|:ref:`Str`|True + +### Options +* rights : :ref:`Flag` **(Required)** + * Default: False +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* no_members : :ref:`Flag` **(Required)** + * Default: False +* version : :ref:`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 \ No newline at end of file diff --git a/doc/api/hbacsvcgroup_add.md b/doc/api/hbacsvcgroup_add.md new file mode 100644 index 000000000..3b1022e72 --- /dev/null +++ b/doc/api/hbacsvcgroup_add.md @@ -0,0 +1,34 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# hbacsvcgroup_add +Add a new HBAC service group. + +### Arguments +|Name|Type|Required +|-|-|- +|cn|:ref:`Str`|True + +### Options +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* no_members : :ref:`Flag` **(Required)** + * Default: False +* description : :ref:`Str` +* setattr : :ref:`Str` +* addattr : :ref:`Str` +* version : :ref:`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 \ No newline at end of file diff --git a/doc/api/hbacsvcgroup_add_member.md b/doc/api/hbacsvcgroup_add_member.md new file mode 100644 index 000000000..f04df064c --- /dev/null +++ b/doc/api/hbacsvcgroup_add_member.md @@ -0,0 +1,32 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# hbacsvcgroup_add_member +Add members to an HBAC service group. + +### Arguments +|Name|Type|Required +|-|-|- +|cn|:ref:`Str`|True + +### Options +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* no_members : :ref:`Flag` **(Required)** + * Default: False +* version : :ref:`Str` +* hbacsvc : :ref:`Str` + +### Output +|Name|Type +|-|- +|completed|Output +|failed|Output +|result|Entry + +[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end) +### Semantics + +### Notes + +### Version differences \ No newline at end of file diff --git a/doc/api/hbacsvcgroup_del.md b/doc/api/hbacsvcgroup_del.md new file mode 100644 index 000000000..f5fe6f4db --- /dev/null +++ b/doc/api/hbacsvcgroup_del.md @@ -0,0 +1,27 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# hbacsvcgroup_del +Delete an HBAC service group. + +### Arguments +|Name|Type|Required +|-|-|- +|cn|:ref:`Str`|True + +### Options +* continue : :ref:`Flag` **(Required)** + * Default: False +* version : :ref:`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 \ No newline at end of file diff --git a/doc/api/hbacsvcgroup_find.md b/doc/api/hbacsvcgroup_find.md new file mode 100644 index 000000000..26be2e46a --- /dev/null +++ b/doc/api/hbacsvcgroup_find.md @@ -0,0 +1,38 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# hbacsvcgroup_find +Search for an HBAC service group. + +### Arguments +|Name|Type|Required +|-|-|- +|criteria|:ref:`Str`|False + +### Options +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* no_members : :ref:`Flag` **(Required)** + * Default: True +* cn : :ref:`Str` +* description : :ref:`Str` +* timelimit : :ref:`Int` +* sizelimit : :ref:`Int` +* version : :ref:`Str` +* pkey_only : :ref:`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 \ No newline at end of file diff --git a/doc/api/hbacsvcgroup_mod.md b/doc/api/hbacsvcgroup_mod.md new file mode 100644 index 000000000..a34c7ac06 --- /dev/null +++ b/doc/api/hbacsvcgroup_mod.md @@ -0,0 +1,37 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# hbacsvcgroup_mod +Modify an HBAC service group. + +### Arguments +|Name|Type|Required +|-|-|- +|cn|:ref:`Str`|True + +### Options +* rights : :ref:`Flag` **(Required)** + * Default: False +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* no_members : :ref:`Flag` **(Required)** + * Default: False +* description : :ref:`Str` +* setattr : :ref:`Str` +* addattr : :ref:`Str` +* delattr : :ref:`Str` +* version : :ref:`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 \ No newline at end of file diff --git a/doc/api/hbacsvcgroup_remove_member.md b/doc/api/hbacsvcgroup_remove_member.md new file mode 100644 index 000000000..d799096ab --- /dev/null +++ b/doc/api/hbacsvcgroup_remove_member.md @@ -0,0 +1,32 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# hbacsvcgroup_remove_member +Remove members from an HBAC service group. + +### Arguments +|Name|Type|Required +|-|-|- +|cn|:ref:`Str`|True + +### Options +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* no_members : :ref:`Flag` **(Required)** + * Default: False +* version : :ref:`Str` +* hbacsvc : :ref:`Str` + +### Output +|Name|Type +|-|- +|completed|Output +|failed|Output +|result|Entry + +[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end) +### Semantics + +### Notes + +### Version differences \ No newline at end of file diff --git a/doc/api/hbacsvcgroup_show.md b/doc/api/hbacsvcgroup_show.md new file mode 100644 index 000000000..423ad3a48 --- /dev/null +++ b/doc/api/hbacsvcgroup_show.md @@ -0,0 +1,33 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# hbacsvcgroup_show +Display information about an HBAC service group. + +### Arguments +|Name|Type|Required +|-|-|- +|cn|:ref:`Str`|True + +### Options +* rights : :ref:`Flag` **(Required)** + * Default: False +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* no_members : :ref:`Flag` **(Required)** + * Default: False +* version : :ref:`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 \ No newline at end of file diff --git a/doc/api/hbactest.md b/doc/api/hbactest.md new file mode 100644 index 000000000..82df9f9ed --- /dev/null +++ b/doc/api/hbactest.md @@ -0,0 +1,38 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# hbactest +Simulate use of Host-based access controls + +### Arguments +No arguments. + +### Options +* user : :ref:`Str` **(Required)** +* targethost : :ref:`Str` **(Required)** +* service : :ref:`Str` **(Required)** +* sourcehost : :ref:`Str` +* rules : :ref:`Str` +* nodetail : :ref:`Flag` + * Default: False +* enabled : :ref:`Flag` + * Default: False +* disabled : :ref:`Flag` + * Default: False +* sizelimit : :ref:`Int` +* version : :ref:`Str` + +### Output +|Name|Type +|-|- +|error|Output +|matched|Output +|notmatched|Output +|summary|Output +|value|Output +|warning|Output + +[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end) +### Semantics + +### Notes + +### Version differences \ No newline at end of file diff --git a/doc/api/host_add.md b/doc/api/host_add.md new file mode 100644 index 000000000..44f8f21fa --- /dev/null +++ b/doc/api/host_add.md @@ -0,0 +1,56 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# host_add +Add a new host. + +### Arguments +|Name|Type|Required +|-|-|- +|fqdn|:ref:`Str`|True + +### Options +* force : :ref:`Flag` **(Required)** + * Default: False +* no_reverse : :ref:`Flag` **(Required)** + * Default: False +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* no_members : :ref:`Flag` **(Required)** + * Default: False +* description : :ref:`Str` +* l : :ref:`Str` +* nshostlocation : :ref:`Str` +* nshardwareplatform : :ref:`Str` +* nsosversion : :ref:`Str` +* userpassword : :ref:`HostPassword` +* random : :ref:`Flag` + * Default: False +* usercertificate : :ref:`Certificate` +* macaddress : :ref:`Str` +* ipasshpubkey : :ref:`Str` +* userclass : :ref:`Str` +* ipaassignedidview : :ref:`Str` +* krbprincipalauthind : :ref:`StrEnum` + * Values: ('radius', 'otp', 'pkinit', 'hardened', 'idp') +* ipakrbrequirespreauth : :ref:`Bool` +* ipakrbokasdelegate : :ref:`Bool` +* ipakrboktoauthasdelegate : :ref:`Bool` +* setattr : :ref:`Str` +* addattr : :ref:`Str` +* ip_address : :ref:`Str` +* version : :ref:`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 \ No newline at end of file diff --git a/doc/api/host_add_cert.md b/doc/api/host_add_cert.md new file mode 100644 index 000000000..240f11971 --- /dev/null +++ b/doc/api/host_add_cert.md @@ -0,0 +1,32 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# host_add_cert +Add certificates to host entry + +### Arguments +|Name|Type|Required +|-|-|- +|fqdn|:ref:`Str`|True + +### Options +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* no_members : :ref:`Flag` **(Required)** + * Default: False +* usercertificate : :ref:`Certificate` **(Required)** +* version : :ref:`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 \ No newline at end of file diff --git a/doc/api/host_add_managedby.md b/doc/api/host_add_managedby.md new file mode 100644 index 000000000..e8d0327ca --- /dev/null +++ b/doc/api/host_add_managedby.md @@ -0,0 +1,32 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# host_add_managedby +Add hosts that can manage this host. + +### Arguments +|Name|Type|Required +|-|-|- +|fqdn|:ref:`Str`|True + +### Options +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* no_members : :ref:`Flag` **(Required)** + * Default: False +* version : :ref:`Str` +* host : :ref:`Str` + +### Output +|Name|Type +|-|- +|completed|Output +|failed|Output +|result|Entry + +[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end) +### Semantics + +### Notes + +### Version differences \ No newline at end of file diff --git a/doc/api/host_add_principal.md b/doc/api/host_add_principal.md new file mode 100644 index 000000000..e1f1cdadd --- /dev/null +++ b/doc/api/host_add_principal.md @@ -0,0 +1,32 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# host_add_principal +Add new principal alias to host entry + +### Arguments +|Name|Type|Required +|-|-|- +|fqdn|:ref:`Str`|True +|krbprincipalname|:ref:`Principal`|True + +### Options +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* no_members : :ref:`Flag` **(Required)** + * Default: False +* version : :ref:`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 \ No newline at end of file diff --git a/doc/api/host_allow_create_keytab.md b/doc/api/host_allow_create_keytab.md new file mode 100644 index 000000000..b6a69e71c --- /dev/null +++ b/doc/api/host_allow_create_keytab.md @@ -0,0 +1,35 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# host_allow_create_keytab +Allow users, groups, hosts or host groups to create a keytab of this host. + +### Arguments +|Name|Type|Required +|-|-|- +|fqdn|:ref:`Str`|True + +### Options +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* no_members : :ref:`Flag` **(Required)** + * Default: False +* version : :ref:`Str` +* user : :ref:`Str` +* group : :ref:`Str` +* host : :ref:`Str` +* hostgroup : :ref:`Str` + +### Output +|Name|Type +|-|- +|completed|Output +|failed|Output +|result|Entry + +[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end) +### Semantics + +### Notes + +### Version differences \ No newline at end of file diff --git a/doc/api/host_allow_retrieve_keytab.md b/doc/api/host_allow_retrieve_keytab.md new file mode 100644 index 000000000..2d7011429 --- /dev/null +++ b/doc/api/host_allow_retrieve_keytab.md @@ -0,0 +1,35 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# host_allow_retrieve_keytab +Allow users, groups, hosts or host groups to retrieve a keytab of this host. + +### Arguments +|Name|Type|Required +|-|-|- +|fqdn|:ref:`Str`|True + +### Options +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* no_members : :ref:`Flag` **(Required)** + * Default: False +* version : :ref:`Str` +* user : :ref:`Str` +* group : :ref:`Str` +* host : :ref:`Str` +* hostgroup : :ref:`Str` + +### Output +|Name|Type +|-|- +|completed|Output +|failed|Output +|result|Entry + +[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end) +### Semantics + +### Notes + +### Version differences \ No newline at end of file diff --git a/doc/api/host_del.md b/doc/api/host_del.md new file mode 100644 index 000000000..cb360704e --- /dev/null +++ b/doc/api/host_del.md @@ -0,0 +1,29 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# host_del +Delete a host. + +### Arguments +|Name|Type|Required +|-|-|- +|fqdn|:ref:`Str`|True + +### Options +* continue : :ref:`Flag` **(Required)** + * Default: False +* updatedns : :ref:`Flag` + * Default: False +* version : :ref:`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 \ No newline at end of file diff --git a/doc/api/host_disable.md b/doc/api/host_disable.md new file mode 100644 index 000000000..e3c8bf928 --- /dev/null +++ b/doc/api/host_disable.md @@ -0,0 +1,25 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# host_disable +Disable the Kerberos key, SSL certificate and all services of a host. + +### Arguments +|Name|Type|Required +|-|-|- +|fqdn|:ref:`Str`|True + +### Options +* version : :ref:`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 \ No newline at end of file diff --git a/doc/api/host_disallow_create_keytab.md b/doc/api/host_disallow_create_keytab.md new file mode 100644 index 000000000..05c32771a --- /dev/null +++ b/doc/api/host_disallow_create_keytab.md @@ -0,0 +1,35 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# host_disallow_create_keytab +Disallow users, groups, hosts or host groups to create a keytab of this host. + +### Arguments +|Name|Type|Required +|-|-|- +|fqdn|:ref:`Str`|True + +### Options +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* no_members : :ref:`Flag` **(Required)** + * Default: False +* version : :ref:`Str` +* user : :ref:`Str` +* group : :ref:`Str` +* host : :ref:`Str` +* hostgroup : :ref:`Str` + +### Output +|Name|Type +|-|- +|completed|Output +|failed|Output +|result|Entry + +[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end) +### Semantics + +### Notes + +### Version differences \ No newline at end of file diff --git a/doc/api/host_disallow_retrieve_keytab.md b/doc/api/host_disallow_retrieve_keytab.md new file mode 100644 index 000000000..adcd2a2d3 --- /dev/null +++ b/doc/api/host_disallow_retrieve_keytab.md @@ -0,0 +1,35 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# host_disallow_retrieve_keytab +Disallow users, groups, hosts or host groups to retrieve a keytab of this host. + +### Arguments +|Name|Type|Required +|-|-|- +|fqdn|:ref:`Str`|True + +### Options +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* no_members : :ref:`Flag` **(Required)** + * Default: False +* version : :ref:`Str` +* user : :ref:`Str` +* group : :ref:`Str` +* host : :ref:`Str` +* hostgroup : :ref:`Str` + +### Output +|Name|Type +|-|- +|completed|Output +|failed|Output +|result|Entry + +[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end) +### Semantics + +### Notes + +### Version differences \ No newline at end of file diff --git a/doc/api/host_find.md b/doc/api/host_find.md new file mode 100644 index 000000000..8b41086b5 --- /dev/null +++ b/doc/api/host_find.md @@ -0,0 +1,64 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# host_find +Search for hosts. + +### Arguments +|Name|Type|Required +|-|-|- +|criteria|:ref:`Str`|False + +### Options +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* no_members : :ref:`Flag` **(Required)** + * Default: True +* fqdn : :ref:`Str` +* description : :ref:`Str` +* l : :ref:`Str` +* nshostlocation : :ref:`Str` +* nshardwareplatform : :ref:`Str` +* nsosversion : :ref:`Str` +* usercertificate : :ref:`Certificate` +* macaddress : :ref:`Str` +* userclass : :ref:`Str` +* ipaassignedidview : :ref:`Str` +* krbprincipalauthind : :ref:`StrEnum` + * Values: ('radius', 'otp', 'pkinit', 'hardened', 'idp') +* timelimit : :ref:`Int` +* sizelimit : :ref:`Int` +* version : :ref:`Str` +* pkey_only : :ref:`Flag` + * Default: False +* in_hostgroup : :ref:`Str` +* not_in_hostgroup : :ref:`Str` +* in_netgroup : :ref:`Str` +* not_in_netgroup : :ref:`Str` +* in_role : :ref:`Str` +* not_in_role : :ref:`Str` +* in_hbacrule : :ref:`Str` +* not_in_hbacrule : :ref:`Str` +* in_sudorule : :ref:`Str` +* not_in_sudorule : :ref:`Str` +* enroll_by_user : :ref:`Str` +* not_enroll_by_user : :ref:`Str` +* man_by_host : :ref:`Str` +* not_man_by_host : :ref:`Str` +* man_host : :ref:`Str` +* not_man_host : :ref:`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 \ No newline at end of file diff --git a/doc/api/host_mod.md b/doc/api/host_mod.md new file mode 100644 index 000000000..05b25cd09 --- /dev/null +++ b/doc/api/host_mod.md @@ -0,0 +1,57 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# host_mod +Modify information about a host. + +### Arguments +|Name|Type|Required +|-|-|- +|fqdn|:ref:`Str`|True + +### Options +* rights : :ref:`Flag` **(Required)** + * Default: False +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* no_members : :ref:`Flag` **(Required)** + * Default: False +* description : :ref:`Str` +* l : :ref:`Str` +* nshostlocation : :ref:`Str` +* nshardwareplatform : :ref:`Str` +* nsosversion : :ref:`Str` +* userpassword : :ref:`HostPassword` +* random : :ref:`Flag` + * Default: False +* usercertificate : :ref:`Certificate` +* krbprincipalname : :ref:`Principal` +* macaddress : :ref:`Str` +* ipasshpubkey : :ref:`Str` +* userclass : :ref:`Str` +* ipaassignedidview : :ref:`Str` +* krbprincipalauthind : :ref:`StrEnum` + * Values: ('radius', 'otp', 'pkinit', 'hardened', 'idp') +* ipakrbrequirespreauth : :ref:`Bool` +* ipakrbokasdelegate : :ref:`Bool` +* ipakrboktoauthasdelegate : :ref:`Bool` +* setattr : :ref:`Str` +* addattr : :ref:`Str` +* delattr : :ref:`Str` +* updatedns : :ref:`Flag` + * Default: False +* version : :ref:`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 \ No newline at end of file diff --git a/doc/api/host_remove_cert.md b/doc/api/host_remove_cert.md new file mode 100644 index 000000000..8813ba7ae --- /dev/null +++ b/doc/api/host_remove_cert.md @@ -0,0 +1,32 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# host_remove_cert +Remove certificates from host entry + +### Arguments +|Name|Type|Required +|-|-|- +|fqdn|:ref:`Str`|True + +### Options +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* no_members : :ref:`Flag` **(Required)** + * Default: False +* usercertificate : :ref:`Certificate` **(Required)** +* version : :ref:`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 \ No newline at end of file diff --git a/doc/api/host_remove_managedby.md b/doc/api/host_remove_managedby.md new file mode 100644 index 000000000..b5c5ab0f9 --- /dev/null +++ b/doc/api/host_remove_managedby.md @@ -0,0 +1,32 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# host_remove_managedby +Remove hosts that can manage this host. + +### Arguments +|Name|Type|Required +|-|-|- +|fqdn|:ref:`Str`|True + +### Options +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* no_members : :ref:`Flag` **(Required)** + * Default: False +* version : :ref:`Str` +* host : :ref:`Str` + +### Output +|Name|Type +|-|- +|completed|Output +|failed|Output +|result|Entry + +[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end) +### Semantics + +### Notes + +### Version differences \ No newline at end of file diff --git a/doc/api/host_remove_principal.md b/doc/api/host_remove_principal.md new file mode 100644 index 000000000..54370859f --- /dev/null +++ b/doc/api/host_remove_principal.md @@ -0,0 +1,32 @@ +[//]: # (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`|True +|krbprincipalname|:ref:`Principal`|True + +### Options +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* no_members : :ref:`Flag` **(Required)** + * Default: False +* version : :ref:`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 \ No newline at end of file diff --git a/doc/api/host_show.md b/doc/api/host_show.md new file mode 100644 index 000000000..724627456 --- /dev/null +++ b/doc/api/host_show.md @@ -0,0 +1,34 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# host_show +Display information about a host. + +### Arguments +|Name|Type|Required +|-|-|- +|fqdn|:ref:`Str`|True + +### Options +* rights : :ref:`Flag` **(Required)** + * Default: False +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* no_members : :ref:`Flag` **(Required)** + * Default: False +* out : :ref:`Str` +* version : :ref:`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 \ No newline at end of file diff --git a/doc/api/hostgroup_add.md b/doc/api/hostgroup_add.md new file mode 100644 index 000000000..bd1267194 --- /dev/null +++ b/doc/api/hostgroup_add.md @@ -0,0 +1,34 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# hostgroup_add +Add a new hostgroup. + +### Arguments +|Name|Type|Required +|-|-|- +|cn|:ref:`Str`|True + +### Options +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* no_members : :ref:`Flag` **(Required)** + * Default: False +* description : :ref:`Str` +* setattr : :ref:`Str` +* addattr : :ref:`Str` +* version : :ref:`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 \ No newline at end of file diff --git a/doc/api/hostgroup_add_member.md b/doc/api/hostgroup_add_member.md new file mode 100644 index 000000000..4365bfc75 --- /dev/null +++ b/doc/api/hostgroup_add_member.md @@ -0,0 +1,33 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# hostgroup_add_member +Add members to a hostgroup. + +### Arguments +|Name|Type|Required +|-|-|- +|cn|:ref:`Str`|True + +### Options +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* no_members : :ref:`Flag` **(Required)** + * Default: False +* version : :ref:`Str` +* host : :ref:`Str` +* hostgroup : :ref:`Str` + +### Output +|Name|Type +|-|- +|completed|Output +|failed|Output +|result|Entry + +[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end) +### Semantics + +### Notes + +### Version differences \ No newline at end of file diff --git a/doc/api/hostgroup_add_member_manager.md b/doc/api/hostgroup_add_member_manager.md new file mode 100644 index 000000000..d7b71b635 --- /dev/null +++ b/doc/api/hostgroup_add_member_manager.md @@ -0,0 +1,33 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# hostgroup_add_member_manager +Add users that can manage members of this hostgroup. + +### Arguments +|Name|Type|Required +|-|-|- +|cn|:ref:`Str`|True + +### Options +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* no_members : :ref:`Flag` **(Required)** + * Default: False +* version : :ref:`Str` +* user : :ref:`Str` +* group : :ref:`Str` + +### Output +|Name|Type +|-|- +|completed|Output +|failed|Output +|result|Entry + +[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end) +### Semantics + +### Notes + +### Version differences \ No newline at end of file diff --git a/doc/api/hostgroup_del.md b/doc/api/hostgroup_del.md new file mode 100644 index 000000000..b1050cae6 --- /dev/null +++ b/doc/api/hostgroup_del.md @@ -0,0 +1,27 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# hostgroup_del +Delete a hostgroup. + +### Arguments +|Name|Type|Required +|-|-|- +|cn|:ref:`Str`|True + +### Options +* continue : :ref:`Flag` **(Required)** + * Default: False +* version : :ref:`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 \ No newline at end of file diff --git a/doc/api/hostgroup_find.md b/doc/api/hostgroup_find.md new file mode 100644 index 000000000..932a066bd --- /dev/null +++ b/doc/api/hostgroup_find.md @@ -0,0 +1,54 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# hostgroup_find +Search for hostgroups. + +### Arguments +|Name|Type|Required +|-|-|- +|criteria|:ref:`Str`|False + +### Options +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* no_members : :ref:`Flag` **(Required)** + * Default: True +* cn : :ref:`Str` +* description : :ref:`Str` +* timelimit : :ref:`Int` +* sizelimit : :ref:`Int` +* version : :ref:`Str` +* pkey_only : :ref:`Flag` + * Default: False +* host : :ref:`Str` +* no_host : :ref:`Str` +* hostgroup : :ref:`Str` +* no_hostgroup : :ref:`Str` +* in_hostgroup : :ref:`Str` +* not_in_hostgroup : :ref:`Str` +* in_netgroup : :ref:`Str` +* not_in_netgroup : :ref:`Str` +* in_hbacrule : :ref:`Str` +* not_in_hbacrule : :ref:`Str` +* in_sudorule : :ref:`Str` +* not_in_sudorule : :ref:`Str` +* membermanager_user : :ref:`Str` +* not_membermanager_user : :ref:`Str` +* membermanager_group : :ref:`Str` +* not_membermanager_group : :ref:`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 \ No newline at end of file diff --git a/doc/api/hostgroup_mod.md b/doc/api/hostgroup_mod.md new file mode 100644 index 000000000..0a77af841 --- /dev/null +++ b/doc/api/hostgroup_mod.md @@ -0,0 +1,38 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# hostgroup_mod +Modify a hostgroup. + +### Arguments +|Name|Type|Required +|-|-|- +|cn|:ref:`Str`|True + +### Options +* rights : :ref:`Flag` **(Required)** + * Default: False +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* no_members : :ref:`Flag` **(Required)** + * Default: False +* description : :ref:`Str` +* setattr : :ref:`Str` +* addattr : :ref:`Str` +* delattr : :ref:`Str` +* version : :ref:`Str` +* rename : :ref:`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 \ No newline at end of file diff --git a/doc/api/hostgroup_remove_member.md b/doc/api/hostgroup_remove_member.md new file mode 100644 index 000000000..52e57d7a4 --- /dev/null +++ b/doc/api/hostgroup_remove_member.md @@ -0,0 +1,33 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# hostgroup_remove_member +Remove members from a hostgroup. + +### Arguments +|Name|Type|Required +|-|-|- +|cn|:ref:`Str`|True + +### Options +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* no_members : :ref:`Flag` **(Required)** + * Default: False +* version : :ref:`Str` +* host : :ref:`Str` +* hostgroup : :ref:`Str` + +### Output +|Name|Type +|-|- +|completed|Output +|failed|Output +|result|Entry + +[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end) +### Semantics + +### Notes + +### Version differences \ No newline at end of file diff --git a/doc/api/hostgroup_remove_member_manager.md b/doc/api/hostgroup_remove_member_manager.md new file mode 100644 index 000000000..be6cc4a1f --- /dev/null +++ b/doc/api/hostgroup_remove_member_manager.md @@ -0,0 +1,33 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# hostgroup_remove_member_manager +Remove users that can manage members of this hostgroup. + +### Arguments +|Name|Type|Required +|-|-|- +|cn|:ref:`Str`|True + +### Options +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* no_members : :ref:`Flag` **(Required)** + * Default: False +* version : :ref:`Str` +* user : :ref:`Str` +* group : :ref:`Str` + +### Output +|Name|Type +|-|- +|completed|Output +|failed|Output +|result|Entry + +[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end) +### Semantics + +### Notes + +### Version differences \ No newline at end of file diff --git a/doc/api/hostgroup_show.md b/doc/api/hostgroup_show.md new file mode 100644 index 000000000..9b8680074 --- /dev/null +++ b/doc/api/hostgroup_show.md @@ -0,0 +1,33 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# hostgroup_show +Display information about a hostgroup. + +### Arguments +|Name|Type|Required +|-|-|- +|cn|:ref:`Str`|True + +### Options +* rights : :ref:`Flag` **(Required)** + * Default: False +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* no_members : :ref:`Flag` **(Required)** + * Default: False +* version : :ref:`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 \ No newline at end of file diff --git a/doc/api/i18n_messages.md b/doc/api/i18n_messages.md new file mode 100644 index 000000000..efd932a8b --- /dev/null +++ b/doc/api/i18n_messages.md @@ -0,0 +1,21 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# i18n_messages +Internationalization messages + +### Arguments +No arguments. + +### Options +* version : :ref:`Str` + +### Output +|Name|Type +|-|- +|texts|Output + +[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end) +### Semantics + +### Notes + +### Version differences \ No newline at end of file diff --git a/doc/api/idoverridegroup_add.md b/doc/api/idoverridegroup_add.md new file mode 100644 index 000000000..081930f17 --- /dev/null +++ b/doc/api/idoverridegroup_add.md @@ -0,0 +1,37 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# idoverridegroup_add +Add a new Group ID override. + +### Arguments +|Name|Type|Required +|-|-|- +|idviewcn|:ref:`Str`|True +|ipaanchoruuid|:ref:`Str`|True + +### Options +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* description : :ref:`Str` +* cn : :ref:`Str` +* gidnumber : :ref:`Int` +* setattr : :ref:`Str` +* addattr : :ref:`Str` +* fallback_to_ldap : :ref:`Flag` + * Default: False +* version : :ref:`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 \ No newline at end of file diff --git a/doc/api/idoverridegroup_del.md b/doc/api/idoverridegroup_del.md new file mode 100644 index 000000000..79dd84ce0 --- /dev/null +++ b/doc/api/idoverridegroup_del.md @@ -0,0 +1,30 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# idoverridegroup_del +Delete an Group ID override. + +### Arguments +|Name|Type|Required +|-|-|- +|idviewcn|:ref:`Str`|True +|ipaanchoruuid|:ref:`Str`|True + +### Options +* continue : :ref:`Flag` **(Required)** + * Default: False +* fallback_to_ldap : :ref:`Flag` + * Default: False +* version : :ref:`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 \ No newline at end of file diff --git a/doc/api/idoverridegroup_find.md b/doc/api/idoverridegroup_find.md new file mode 100644 index 000000000..741b9ff24 --- /dev/null +++ b/doc/api/idoverridegroup_find.md @@ -0,0 +1,41 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# idoverridegroup_find +Search for an Group ID override. + +### Arguments +|Name|Type|Required +|-|-|- +|idviewcn|:ref:`Str`|True +|criteria|:ref:`Str`|False + +### Options +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* ipaanchoruuid : :ref:`Str` +* description : :ref:`Str` +* cn : :ref:`Str` +* gidnumber : :ref:`Int` +* timelimit : :ref:`Int` +* sizelimit : :ref:`Int` +* fallback_to_ldap : :ref:`Flag` + * Default: False +* version : :ref:`Str` +* pkey_only : :ref:`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 \ No newline at end of file diff --git a/doc/api/idoverridegroup_mod.md b/doc/api/idoverridegroup_mod.md new file mode 100644 index 000000000..d550e4e70 --- /dev/null +++ b/doc/api/idoverridegroup_mod.md @@ -0,0 +1,41 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# idoverridegroup_mod +Modify an Group ID override. + +### Arguments +|Name|Type|Required +|-|-|- +|idviewcn|:ref:`Str`|True +|ipaanchoruuid|:ref:`Str`|True + +### Options +* rights : :ref:`Flag` **(Required)** + * Default: False +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* description : :ref:`Str` +* cn : :ref:`Str` +* gidnumber : :ref:`Int` +* setattr : :ref:`Str` +* addattr : :ref:`Str` +* delattr : :ref:`Str` +* fallback_to_ldap : :ref:`Flag` + * Default: False +* version : :ref:`Str` +* rename : :ref:`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 \ No newline at end of file diff --git a/doc/api/idoverridegroup_show.md b/doc/api/idoverridegroup_show.md new file mode 100644 index 000000000..9757295f6 --- /dev/null +++ b/doc/api/idoverridegroup_show.md @@ -0,0 +1,34 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# idoverridegroup_show +Display information about an Group ID override. + +### Arguments +|Name|Type|Required +|-|-|- +|idviewcn|:ref:`Str`|True +|ipaanchoruuid|:ref:`Str`|True + +### Options +* rights : :ref:`Flag` **(Required)** + * Default: False +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* fallback_to_ldap : :ref:`Flag` + * Default: False +* version : :ref:`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 \ No newline at end of file diff --git a/doc/api/idoverrideuser_add.md b/doc/api/idoverrideuser_add.md new file mode 100644 index 000000000..7bfde68ee --- /dev/null +++ b/doc/api/idoverrideuser_add.md @@ -0,0 +1,46 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# idoverrideuser_add +Add a new User ID override. + +### Arguments +|Name|Type|Required +|-|-|- +|idviewcn|:ref:`Str`|True +|ipaanchoruuid|:ref:`Str`|True + +### Options +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* no_members : :ref:`Flag` **(Required)** + * Default: False +* description : :ref:`Str` +* uid : :ref:`Str` +* uidnumber : :ref:`Int` +* gecos : :ref:`Str` +* gidnumber : :ref:`Int` +* homedirectory : :ref:`Str` +* loginshell : :ref:`Str` +* ipaoriginaluid : :ref:`Str` +* ipasshpubkey : :ref:`Str` +* usercertificate : :ref:`Certificate` +* setattr : :ref:`Str` +* addattr : :ref:`Str` +* fallback_to_ldap : :ref:`Flag` + * Default: False +* version : :ref:`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 \ No newline at end of file diff --git a/doc/api/idoverrideuser_add_cert.md b/doc/api/idoverrideuser_add_cert.md new file mode 100644 index 000000000..8db1089ba --- /dev/null +++ b/doc/api/idoverrideuser_add_cert.md @@ -0,0 +1,35 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# idoverrideuser_add_cert +Add one or more certificates to the idoverrideuser entry + +### Arguments +|Name|Type|Required +|-|-|- +|idviewcn|:ref:`Str`|True +|ipaanchoruuid|:ref:`Str`|True + +### Options +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* no_members : :ref:`Flag` **(Required)** + * Default: False +* usercertificate : :ref:`Certificate` **(Required)** +* fallback_to_ldap : :ref:`Flag` + * Default: False +* version : :ref:`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 \ No newline at end of file diff --git a/doc/api/idoverrideuser_del.md b/doc/api/idoverrideuser_del.md new file mode 100644 index 000000000..c9d318571 --- /dev/null +++ b/doc/api/idoverrideuser_del.md @@ -0,0 +1,30 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# idoverrideuser_del +Delete an User ID override. + +### Arguments +|Name|Type|Required +|-|-|- +|idviewcn|:ref:`Str`|True +|ipaanchoruuid|:ref:`Str`|True + +### Options +* continue : :ref:`Flag` **(Required)** + * Default: False +* fallback_to_ldap : :ref:`Flag` + * Default: False +* version : :ref:`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 \ No newline at end of file diff --git a/doc/api/idoverrideuser_find.md b/doc/api/idoverrideuser_find.md new file mode 100644 index 000000000..e9ac11818 --- /dev/null +++ b/doc/api/idoverrideuser_find.md @@ -0,0 +1,48 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# idoverrideuser_find +Search for an User ID override. + +### Arguments +|Name|Type|Required +|-|-|- +|idviewcn|:ref:`Str`|True +|criteria|:ref:`Str`|False + +### Options +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* no_members : :ref:`Flag` **(Required)** + * Default: True +* ipaanchoruuid : :ref:`Str` +* description : :ref:`Str` +* uid : :ref:`Str` +* uidnumber : :ref:`Int` +* gecos : :ref:`Str` +* gidnumber : :ref:`Int` +* homedirectory : :ref:`Str` +* loginshell : :ref:`Str` +* ipaoriginaluid : :ref:`Str` +* timelimit : :ref:`Int` +* sizelimit : :ref:`Int` +* fallback_to_ldap : :ref:`Flag` + * Default: False +* version : :ref:`Str` +* pkey_only : :ref:`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 \ No newline at end of file diff --git a/doc/api/idoverrideuser_mod.md b/doc/api/idoverrideuser_mod.md new file mode 100644 index 000000000..a978c3b83 --- /dev/null +++ b/doc/api/idoverrideuser_mod.md @@ -0,0 +1,50 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# idoverrideuser_mod +Modify an User ID override. + +### Arguments +|Name|Type|Required +|-|-|- +|idviewcn|:ref:`Str`|True +|ipaanchoruuid|:ref:`Str`|True + +### Options +* rights : :ref:`Flag` **(Required)** + * Default: False +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* no_members : :ref:`Flag` **(Required)** + * Default: False +* description : :ref:`Str` +* uid : :ref:`Str` +* uidnumber : :ref:`Int` +* gecos : :ref:`Str` +* gidnumber : :ref:`Int` +* homedirectory : :ref:`Str` +* loginshell : :ref:`Str` +* ipaoriginaluid : :ref:`Str` +* ipasshpubkey : :ref:`Str` +* usercertificate : :ref:`Certificate` +* setattr : :ref:`Str` +* addattr : :ref:`Str` +* delattr : :ref:`Str` +* fallback_to_ldap : :ref:`Flag` + * Default: False +* version : :ref:`Str` +* rename : :ref:`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 \ No newline at end of file diff --git a/doc/api/idoverrideuser_remove_cert.md b/doc/api/idoverrideuser_remove_cert.md new file mode 100644 index 000000000..8e504ce2a --- /dev/null +++ b/doc/api/idoverrideuser_remove_cert.md @@ -0,0 +1,35 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# idoverrideuser_remove_cert +Remove one or more certificates to the idoverrideuser entry + +### Arguments +|Name|Type|Required +|-|-|- +|idviewcn|:ref:`Str`|True +|ipaanchoruuid|:ref:`Str`|True + +### Options +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* no_members : :ref:`Flag` **(Required)** + * Default: False +* usercertificate : :ref:`Certificate` **(Required)** +* fallback_to_ldap : :ref:`Flag` + * Default: False +* version : :ref:`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 \ No newline at end of file diff --git a/doc/api/idoverrideuser_show.md b/doc/api/idoverrideuser_show.md new file mode 100644 index 000000000..a991ec1e6 --- /dev/null +++ b/doc/api/idoverrideuser_show.md @@ -0,0 +1,36 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# idoverrideuser_show +Display information about an User ID override. + +### Arguments +|Name|Type|Required +|-|-|- +|idviewcn|:ref:`Str`|True +|ipaanchoruuid|:ref:`Str`|True + +### Options +* rights : :ref:`Flag` **(Required)** + * Default: False +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* no_members : :ref:`Flag` **(Required)** + * Default: False +* fallback_to_ldap : :ref:`Flag` + * Default: False +* version : :ref:`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 \ No newline at end of file diff --git a/doc/api/idp_add.md b/doc/api/idp_add.md new file mode 100644 index 000000000..feb8d0737 --- /dev/null +++ b/doc/api/idp_add.md @@ -0,0 +1,45 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# idp_add +Add a new Identity Provider server. + +### Arguments +|Name|Type|Required +|-|-|- +|cn|:ref:`Str`|True + +### Options +* ipaidpclientid : :ref:`Str` **(Required)** +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* ipaidpauthendpoint : :ref:`Str` +* ipaidpdevauthendpoint : :ref:`Str` +* ipaidptokenendpoint : :ref:`Str` +* ipaidpuserinfoendpoint : :ref:`Str` +* ipaidpkeysendpoint : :ref:`Str` +* ipaidpissuerurl : :ref:`Str` +* ipaidpclientsecret : :ref:`Password` +* ipaidpscope : :ref:`Str` +* ipaidpsub : :ref:`Str` +* setattr : :ref:`Str` +* addattr : :ref:`Str` +* ipaidpprovider : :ref:`StrEnum` + * Values: ('google', 'github', 'microsoft', 'okta', 'keycloak') +* ipaidporg : :ref:`Str` +* ipaidpbaseurl : :ref:`Str` +* version : :ref:`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 \ No newline at end of file diff --git a/doc/api/idp_del.md b/doc/api/idp_del.md new file mode 100644 index 000000000..881782bbf --- /dev/null +++ b/doc/api/idp_del.md @@ -0,0 +1,27 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# idp_del +Delete an Identity Provider server. + +### Arguments +|Name|Type|Required +|-|-|- +|cn|:ref:`Str`|True + +### Options +* continue : :ref:`Flag` **(Required)** + * Default: False +* version : :ref:`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 \ No newline at end of file diff --git a/doc/api/idp_find.md b/doc/api/idp_find.md new file mode 100644 index 000000000..606f2c0a4 --- /dev/null +++ b/doc/api/idp_find.md @@ -0,0 +1,45 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# idp_find +Search for Identity Provider servers. + +### Arguments +|Name|Type|Required +|-|-|- +|criteria|:ref:`Str`|False + +### Options +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* cn : :ref:`Str` +* ipaidpauthendpoint : :ref:`Str` +* ipaidpdevauthendpoint : :ref:`Str` +* ipaidptokenendpoint : :ref:`Str` +* ipaidpuserinfoendpoint : :ref:`Str` +* ipaidpkeysendpoint : :ref:`Str` +* ipaidpissuerurl : :ref:`Str` +* ipaidpclientid : :ref:`Str` +* ipaidpclientsecret : :ref:`Password` +* ipaidpscope : :ref:`Str` +* ipaidpsub : :ref:`Str` +* timelimit : :ref:`Int` +* sizelimit : :ref:`Int` +* version : :ref:`Str` +* pkey_only : :ref:`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 \ No newline at end of file diff --git a/doc/api/idp_mod.md b/doc/api/idp_mod.md new file mode 100644 index 000000000..778147081 --- /dev/null +++ b/doc/api/idp_mod.md @@ -0,0 +1,45 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# idp_mod +Modify an Identity Provider server. + +### Arguments +|Name|Type|Required +|-|-|- +|cn|:ref:`Str`|True + +### Options +* rights : :ref:`Flag` **(Required)** + * Default: False +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* ipaidpauthendpoint : :ref:`Str` +* ipaidpdevauthendpoint : :ref:`Str` +* ipaidptokenendpoint : :ref:`Str` +* ipaidpuserinfoendpoint : :ref:`Str` +* ipaidpkeysendpoint : :ref:`Str` +* ipaidpissuerurl : :ref:`Str` +* ipaidpclientid : :ref:`Str` +* ipaidpclientsecret : :ref:`Password` +* ipaidpscope : :ref:`Str` +* ipaidpsub : :ref:`Str` +* setattr : :ref:`Str` +* addattr : :ref:`Str` +* delattr : :ref:`Str` +* version : :ref:`Str` +* rename : :ref:`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 \ No newline at end of file diff --git a/doc/api/idp_show.md b/doc/api/idp_show.md new file mode 100644 index 000000000..ad95c7935 --- /dev/null +++ b/doc/api/idp_show.md @@ -0,0 +1,31 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# idp_show +Display information about an Identity Provider server. + +### Arguments +|Name|Type|Required +|-|-|- +|cn|:ref:`Str`|True + +### Options +* rights : :ref:`Flag` **(Required)** + * Default: False +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* version : :ref:`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 \ No newline at end of file diff --git a/doc/api/idrange_add.md b/doc/api/idrange_add.md new file mode 100644 index 000000000..ff288fce9 --- /dev/null +++ b/doc/api/idrange_add.md @@ -0,0 +1,77 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# idrange_add + +Add new ID range. + +To add a new ID range you always have to specify + +--base-id +--range-size + +Additionally + +--rid-base +--secondary-rid-base + +may be given for a new ID range for the local domain while + +--auto-private-groups + +may be given for a new ID range for a trusted AD domain and + +--rid-base +--dom-sid + +must be given to add a new range for a trusted AD domain. + +------- +WARNING: + +DNA plugin in 389-ds will allocate IDs based on the ranges configured for the +local domain. Currently the DNA plugin *cannot* be reconfigured itself based +on the local ranges set via this family of commands. + +Manual configuration change has to be done in the DNA plugin configuration for +the new local range. Specifically, The dnaNextRange attribute of 'cn=Posix +IDs,cn=Distributed Numeric Assignment Plugin,cn=plugins,cn=config' has to be +modified to match the new range. + +------- + +### Arguments +|Name|Type|Required +|-|-|- +|cn|:ref:`Str`|True + +### Options +* ipabaseid : :ref:`Int` **(Required)** +* ipaidrangesize : :ref:`Int` **(Required)** +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* ipabaserid : :ref:`Int` +* ipasecondarybaserid : :ref:`Int` +* ipanttrusteddomainsid : :ref:`Str` +* ipanttrusteddomainname : :ref:`Str` +* iparangetype : :ref:`StrEnum` + * Values: ('ipa-ad-trust', 'ipa-ad-trust-posix', 'ipa-local') +* ipaautoprivategroups : :ref:`StrEnum` + * Values: ('true', 'false', 'hybrid') +* setattr : :ref:`Str` +* addattr : :ref:`Str` +* version : :ref:`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 \ No newline at end of file diff --git a/doc/api/idrange_del.md b/doc/api/idrange_del.md new file mode 100644 index 000000000..24afacd17 --- /dev/null +++ b/doc/api/idrange_del.md @@ -0,0 +1,27 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# idrange_del +Delete an ID range. + +### Arguments +|Name|Type|Required +|-|-|- +|cn|:ref:`Str`|True + +### Options +* continue : :ref:`Flag` **(Required)** + * Default: False +* version : :ref:`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 \ No newline at end of file diff --git a/doc/api/idrange_find.md b/doc/api/idrange_find.md new file mode 100644 index 000000000..3fb792c43 --- /dev/null +++ b/doc/api/idrange_find.md @@ -0,0 +1,44 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# idrange_find +Search for ranges. + +### Arguments +|Name|Type|Required +|-|-|- +|criteria|:ref:`Str`|False + +### Options +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* cn : :ref:`Str` +* ipabaseid : :ref:`Int` +* ipaidrangesize : :ref:`Int` +* ipabaserid : :ref:`Int` +* ipasecondarybaserid : :ref:`Int` +* ipanttrusteddomainsid : :ref:`Str` +* iparangetype : :ref:`StrEnum` + * Values: ('ipa-ad-trust', 'ipa-ad-trust-posix', 'ipa-local') +* ipaautoprivategroups : :ref:`StrEnum` + * Values: ('true', 'false', 'hybrid') +* timelimit : :ref:`Int` +* sizelimit : :ref:`Int` +* version : :ref:`Str` +* pkey_only : :ref:`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 \ No newline at end of file diff --git a/doc/api/idrange_mod.md b/doc/api/idrange_mod.md new file mode 100644 index 000000000..e2e448a29 --- /dev/null +++ b/doc/api/idrange_mod.md @@ -0,0 +1,56 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# idrange_mod +Modify ID range. + +------- +WARNING: + +DNA plugin in 389-ds will allocate IDs based on the ranges configured for the +local domain. Currently the DNA plugin *cannot* be reconfigured itself based +on the local ranges set via this family of commands. + +Manual configuration change has to be done in the DNA plugin configuration for +the new local range. Specifically, The dnaNextRange attribute of 'cn=Posix +IDs,cn=Distributed Numeric Assignment Plugin,cn=plugins,cn=config' has to be +modified to match the new range. + +------- + +### Arguments +|Name|Type|Required +|-|-|- +|cn|:ref:`Str`|True + +### Options +* rights : :ref:`Flag` **(Required)** + * Default: False +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* ipabaseid : :ref:`Int` +* ipaidrangesize : :ref:`Int` +* ipabaserid : :ref:`Int` +* ipasecondarybaserid : :ref:`Int` +* ipaautoprivategroups : :ref:`StrEnum` + * Values: ('true', 'false', 'hybrid') +* setattr : :ref:`Str` +* addattr : :ref:`Str` +* delattr : :ref:`Str` +* ipanttrusteddomainsid : :ref:`Str` +* ipanttrusteddomainname : :ref:`Str` +* version : :ref:`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 \ No newline at end of file diff --git a/doc/api/idrange_show.md b/doc/api/idrange_show.md new file mode 100644 index 000000000..43e99376e --- /dev/null +++ b/doc/api/idrange_show.md @@ -0,0 +1,31 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# idrange_show +Display information about a range. + +### Arguments +|Name|Type|Required +|-|-|- +|cn|:ref:`Str`|True + +### Options +* rights : :ref:`Flag` **(Required)** + * Default: False +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* version : :ref:`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 \ No newline at end of file diff --git a/doc/api/idview_add.md b/doc/api/idview_add.md new file mode 100644 index 000000000..c60ca7360 --- /dev/null +++ b/doc/api/idview_add.md @@ -0,0 +1,33 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# idview_add +Add a new ID View. + +### Arguments +|Name|Type|Required +|-|-|- +|cn|:ref:`Str`|True + +### Options +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* description : :ref:`Str` +* ipadomainresolutionorder : :ref:`Str` +* setattr : :ref:`Str` +* addattr : :ref:`Str` +* version : :ref:`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 \ No newline at end of file diff --git a/doc/api/idview_apply.md b/doc/api/idview_apply.md new file mode 100644 index 000000000..a0b9b31d6 --- /dev/null +++ b/doc/api/idview_apply.md @@ -0,0 +1,28 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# idview_apply +Applies ID View to specified hosts or current members of specified hostgroups. If any other ID View is applied to the host, it is overridden. + +### Arguments +|Name|Type|Required +|-|-|- +|cn|:ref:`Str`|True + +### Options +* host : :ref:`Str` +* hostgroup : :ref:`Str` +* version : :ref:`Str` + +### Output +|Name|Type +|-|- +|completed|Output +|failed|Output +|succeeded|Output +|summary|Output + +[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end) +### Semantics + +### Notes + +### Version differences \ No newline at end of file diff --git a/doc/api/idview_del.md b/doc/api/idview_del.md new file mode 100644 index 000000000..50d0d8ee4 --- /dev/null +++ b/doc/api/idview_del.md @@ -0,0 +1,27 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# idview_del +Delete an ID View. + +### Arguments +|Name|Type|Required +|-|-|- +|cn|:ref:`Str`|True + +### Options +* continue : :ref:`Flag` **(Required)** + * Default: False +* version : :ref:`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 \ No newline at end of file diff --git a/doc/api/idview_find.md b/doc/api/idview_find.md new file mode 100644 index 000000000..4048011d2 --- /dev/null +++ b/doc/api/idview_find.md @@ -0,0 +1,36 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# idview_find +Search for an ID View. + +### Arguments +|Name|Type|Required +|-|-|- +|criteria|:ref:`Str`|False + +### Options +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* cn : :ref:`Str` +* description : :ref:`Str` +* timelimit : :ref:`Int` +* sizelimit : :ref:`Int` +* version : :ref:`Str` +* pkey_only : :ref:`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 \ No newline at end of file diff --git a/doc/api/idview_mod.md b/doc/api/idview_mod.md new file mode 100644 index 000000000..e7c03f0bf --- /dev/null +++ b/doc/api/idview_mod.md @@ -0,0 +1,37 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# idview_mod +Modify an ID View. + +### Arguments +|Name|Type|Required +|-|-|- +|cn|:ref:`Str`|True + +### Options +* rights : :ref:`Flag` **(Required)** + * Default: False +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* description : :ref:`Str` +* ipadomainresolutionorder : :ref:`Str` +* setattr : :ref:`Str` +* addattr : :ref:`Str` +* delattr : :ref:`Str` +* version : :ref:`Str` +* rename : :ref:`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 \ No newline at end of file diff --git a/doc/api/idview_show.md b/doc/api/idview_show.md new file mode 100644 index 000000000..5bd487dd4 --- /dev/null +++ b/doc/api/idview_show.md @@ -0,0 +1,33 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# idview_show +Display information about an ID View. + +### Arguments +|Name|Type|Required +|-|-|- +|cn|:ref:`Str`|True + +### Options +* rights : :ref:`Flag` **(Required)** + * Default: False +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* show_hosts : :ref:`Flag` + * Default: False +* version : :ref:`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 \ No newline at end of file diff --git a/doc/api/idview_unapply.md b/doc/api/idview_unapply.md new file mode 100644 index 000000000..2f812ea8f --- /dev/null +++ b/doc/api/idview_unapply.md @@ -0,0 +1,26 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# idview_unapply +Clears ID View from specified hosts or current members of specified hostgroups. + +### Arguments +No arguments. + +### Options +* host : :ref:`Str` +* hostgroup : :ref:`Str` +* version : :ref:`Str` + +### Output +|Name|Type +|-|- +|completed|Output +|failed|Output +|succeeded|Output +|summary|Output + +[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end) +### Semantics + +### Notes + +### Version differences \ No newline at end of file diff --git a/doc/api/index.rst b/doc/api/index.rst new file mode 100644 index 000000000..16a451e8e --- /dev/null +++ b/doc/api/index.rst @@ -0,0 +1,7 @@ +IPA API Reference +================= +.. toctree:: + :maxdepth: 1 + + commands.rst + parameters.rst diff --git a/doc/api/join.md b/doc/api/join.md new file mode 100644 index 000000000..838a412a6 --- /dev/null +++ b/doc/api/join.md @@ -0,0 +1,24 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# join +Join an IPA domain + +### Arguments +|Name|Type|Required +|-|-|- +|cn|:ref:`Str`|True + +### Options +* realm : :ref:`Str` **(Required)** +* nshardwareplatform : :ref:`Str` +* nsosversion : :ref:`Str` +* version : :ref:`Str` + +### Output +No output. + +[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end) +### Semantics + +### Notes + +### Version differences \ No newline at end of file diff --git a/doc/api/json_metadata.md b/doc/api/json_metadata.md new file mode 100644 index 000000000..bd961a0fd --- /dev/null +++ b/doc/api/json_metadata.md @@ -0,0 +1,29 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# json_metadata +Export plugin meta-data for the webUI. + +### Arguments +|Name|Type|Required +|-|-|- +|objname|:ref:`Str`|False +|methodname|:ref:`Str`|False + +### Options +* object : :ref:`Str` +* method : :ref:`Str` +* command : :ref:`Str` +* version : :ref:`Str` + +### Output +|Name|Type +|-|- +|commands|Output +|methods|Output +|objects|Output + +[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end) +### Semantics + +### Notes + +### Version differences \ No newline at end of file diff --git a/doc/api/kra_is_enabled.md b/doc/api/kra_is_enabled.md new file mode 100644 index 000000000..2ec9a16f2 --- /dev/null +++ b/doc/api/kra_is_enabled.md @@ -0,0 +1,23 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# kra_is_enabled +Checks if any of the servers has the KRA service enabled + +### Arguments +No arguments. + +### Options +* version : :ref:`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 \ No newline at end of file diff --git a/doc/api/krbtpolicy_mod.md b/doc/api/krbtpolicy_mod.md new file mode 100644 index 000000000..ee2eb3ed1 --- /dev/null +++ b/doc/api/krbtpolicy_mod.md @@ -0,0 +1,46 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# krbtpolicy_mod +Modify Kerberos ticket policy. + +### Arguments +|Name|Type|Required +|-|-|- +|uid|:ref:`Str`|False + +### Options +* rights : :ref:`Flag` **(Required)** + * Default: False +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* krbmaxticketlife : :ref:`Int` +* krbmaxrenewableage : :ref:`Int` +* krbauthindmaxticketlife_otp : :ref:`Int` +* krbauthindmaxrenewableage_otp : :ref:`Int` +* krbauthindmaxticketlife_radius : :ref:`Int` +* krbauthindmaxrenewableage_radius : :ref:`Int` +* krbauthindmaxticketlife_pkinit : :ref:`Int` +* krbauthindmaxrenewableage_pkinit : :ref:`Int` +* krbauthindmaxticketlife_hardened : :ref:`Int` +* krbauthindmaxrenewableage_hardened : :ref:`Int` +* krbauthindmaxticketlife_idp : :ref:`Int` +* krbauthindmaxrenewableage_idp : :ref:`Int` +* setattr : :ref:`Str` +* addattr : :ref:`Str` +* delattr : :ref:`Str` +* version : :ref:`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 \ No newline at end of file diff --git a/doc/api/krbtpolicy_reset.md b/doc/api/krbtpolicy_reset.md new file mode 100644 index 000000000..f189c3e5a --- /dev/null +++ b/doc/api/krbtpolicy_reset.md @@ -0,0 +1,29 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# krbtpolicy_reset +Reset Kerberos ticket policy to the default values. + +### Arguments +|Name|Type|Required +|-|-|- +|uid|:ref:`Str`|False + +### Options +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* version : :ref:`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 \ No newline at end of file diff --git a/doc/api/krbtpolicy_show.md b/doc/api/krbtpolicy_show.md new file mode 100644 index 000000000..a30db7791 --- /dev/null +++ b/doc/api/krbtpolicy_show.md @@ -0,0 +1,31 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# krbtpolicy_show +Display the current Kerberos ticket policy. + +### Arguments +|Name|Type|Required +|-|-|- +|uid|:ref:`Str`|False + +### Options +* rights : :ref:`Flag` **(Required)** + * Default: False +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* version : :ref:`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 \ No newline at end of file diff --git a/doc/api/location_add.md b/doc/api/location_add.md new file mode 100644 index 000000000..2ffa85378 --- /dev/null +++ b/doc/api/location_add.md @@ -0,0 +1,32 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# location_add +Add a new IPA location. + +### Arguments +|Name|Type|Required +|-|-|- +|idnsname|:ref:`DNSNameParam`|True + +### Options +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* description : :ref:`Str` +* setattr : :ref:`Str` +* addattr : :ref:`Str` +* version : :ref:`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 \ No newline at end of file diff --git a/doc/api/location_del.md b/doc/api/location_del.md new file mode 100644 index 000000000..4391a785c --- /dev/null +++ b/doc/api/location_del.md @@ -0,0 +1,27 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# location_del +Delete an IPA location. + +### Arguments +|Name|Type|Required +|-|-|- +|idnsname|:ref:`DNSNameParam`|True + +### Options +* continue : :ref:`Flag` **(Required)** + * Default: False +* version : :ref:`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 \ No newline at end of file diff --git a/doc/api/location_find.md b/doc/api/location_find.md new file mode 100644 index 000000000..82d8dee94 --- /dev/null +++ b/doc/api/location_find.md @@ -0,0 +1,36 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# location_find +Search for IPA locations. + +### Arguments +|Name|Type|Required +|-|-|- +|criteria|:ref:`Str`|False + +### Options +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* idnsname : :ref:`DNSNameParam` +* description : :ref:`Str` +* timelimit : :ref:`Int` +* sizelimit : :ref:`Int` +* version : :ref:`Str` +* pkey_only : :ref:`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 \ No newline at end of file diff --git a/doc/api/location_mod.md b/doc/api/location_mod.md new file mode 100644 index 000000000..ac6eefde8 --- /dev/null +++ b/doc/api/location_mod.md @@ -0,0 +1,35 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# location_mod +Modify information about an IPA location. + +### Arguments +|Name|Type|Required +|-|-|- +|idnsname|:ref:`DNSNameParam`|True + +### Options +* rights : :ref:`Flag` **(Required)** + * Default: False +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* description : :ref:`Str` +* setattr : :ref:`Str` +* addattr : :ref:`Str` +* delattr : :ref:`Str` +* version : :ref:`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 \ No newline at end of file diff --git a/doc/api/location_show.md b/doc/api/location_show.md new file mode 100644 index 000000000..10d3e0de9 --- /dev/null +++ b/doc/api/location_show.md @@ -0,0 +1,32 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# location_show +Display information about an IPA location. + +### Arguments +|Name|Type|Required +|-|-|- +|idnsname|:ref:`DNSNameParam`|True + +### Options +* rights : :ref:`Flag` **(Required)** + * Default: False +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* version : :ref:`Str` + +### Output +|Name|Type +|-|- +|result|Entry +|servers|Output +|summary|Output +|value|PrimaryKey + +[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end) +### Semantics + +### Notes + +### Version differences \ No newline at end of file diff --git a/doc/api/migrate_ds.md b/doc/api/migrate_ds.md new file mode 100644 index 000000000..31af0ff84 --- /dev/null +++ b/doc/api/migrate_ds.md @@ -0,0 +1,65 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# migrate_ds +Migrate users and groups from DS to IPA. + +### Arguments +|Name|Type|Required +|-|-|- +|ldapuri|:ref:`Str`|True +|bindpw|:ref:`Password`|True + +### Options +* usercontainer : :ref:`DNParam` **(Required)** + * Default: ou=people +* groupcontainer : :ref:`DNParam` **(Required)** + * Default: ou=groups +* userobjectclass : :ref:`Str` **(Required)** + * Default: ('person',) +* groupobjectclass : :ref:`Str` **(Required)** + * Default: ('groupOfUniqueNames', 'groupOfNames') +* groupoverwritegid : :ref:`Flag` **(Required)** + * Default: False +* scope : :ref:`StrEnum` **(Required)** + * Default: onelevel + * Values: ('base', 'onelevel', 'subtree') +* binddn : :ref:`DNParam` + * Default: cn=directory manager +* userignoreobjectclass : :ref:`Str` + * Default: () +* userignoreattribute : :ref:`Str` + * Default: () +* groupignoreobjectclass : :ref:`Str` + * Default: () +* groupignoreattribute : :ref:`Str` + * Default: () +* schema : :ref:`StrEnum` + * Default: RFC2307bis + * Values: ('RFC2307bis', 'RFC2307') +* continue : :ref:`Flag` + * Default: False +* basedn : :ref:`DNParam` +* compat : :ref:`Flag` + * Default: False +* cacertfile : :ref:`Str` +* use_def_group : :ref:`Bool` + * Default: True +* version : :ref:`Str` +* exclude_users : :ref:`Str` + * Default: () +* exclude_groups : :ref:`Str` + * Default: () + +### Output +|Name|Type +|-|- +|compat|Output +|enabled|Output +|failed|Output +|result|Output + +[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end) +### Semantics + +### Notes + +### Version differences \ No newline at end of file diff --git a/doc/api/netgroup_add.md b/doc/api/netgroup_add.md new file mode 100644 index 000000000..4153551ec --- /dev/null +++ b/doc/api/netgroup_add.md @@ -0,0 +1,40 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# netgroup_add +Add a new netgroup. + +### Arguments +|Name|Type|Required +|-|-|- +|cn|:ref:`Str`|True + +### Options +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* no_members : :ref:`Flag` **(Required)** + * Default: False +* description : :ref:`Str` +* nisdomainname : :ref:`Str` +* usercategory : :ref:`StrEnum` + * Values: ('all',) +* hostcategory : :ref:`StrEnum` + * Values: ('all',) +* externalhost : :ref:`Str` +* setattr : :ref:`Str` +* addattr : :ref:`Str` +* version : :ref:`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 \ No newline at end of file diff --git a/doc/api/netgroup_add_member.md b/doc/api/netgroup_add_member.md new file mode 100644 index 000000000..e9c60f17b --- /dev/null +++ b/doc/api/netgroup_add_member.md @@ -0,0 +1,36 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# netgroup_add_member +Add members to a netgroup. + +### Arguments +|Name|Type|Required +|-|-|- +|cn|:ref:`Str`|True + +### Options +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* no_members : :ref:`Flag` **(Required)** + * Default: False +* version : :ref:`Str` +* user : :ref:`Str` +* group : :ref:`Str` +* host : :ref:`Str` +* hostgroup : :ref:`Str` +* netgroup : :ref:`Str` + +### Output +|Name|Type +|-|- +|completed|Output +|failed|Output +|result|Entry + +[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end) +### Semantics + +### Notes + +### Version differences \ No newline at end of file diff --git a/doc/api/netgroup_del.md b/doc/api/netgroup_del.md new file mode 100644 index 000000000..2dcb392b0 --- /dev/null +++ b/doc/api/netgroup_del.md @@ -0,0 +1,27 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# netgroup_del +Delete a netgroup. + +### Arguments +|Name|Type|Required +|-|-|- +|cn|:ref:`Str`|True + +### Options +* continue : :ref:`Flag` **(Required)** + * Default: False +* version : :ref:`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 \ No newline at end of file diff --git a/doc/api/netgroup_find.md b/doc/api/netgroup_find.md new file mode 100644 index 000000000..19ad9b320 --- /dev/null +++ b/doc/api/netgroup_find.md @@ -0,0 +1,61 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# netgroup_find +Search for a netgroup. + +### Arguments +|Name|Type|Required +|-|-|- +|criteria|:ref:`Str`|False + +### Options +* private : :ref:`Flag` **(Required)** + * Default: False +* managed : :ref:`Flag` **(Required)** + * Default: False +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* no_members : :ref:`Flag` **(Required)** + * Default: True +* cn : :ref:`Str` +* description : :ref:`Str` +* nisdomainname : :ref:`Str` +* ipauniqueid : :ref:`Str` +* usercategory : :ref:`StrEnum` + * Values: ('all',) +* hostcategory : :ref:`StrEnum` + * Values: ('all',) +* externalhost : :ref:`Str` +* timelimit : :ref:`Int` +* sizelimit : :ref:`Int` +* version : :ref:`Str` +* pkey_only : :ref:`Flag` + * Default: False +* netgroup : :ref:`Str` +* no_netgroup : :ref:`Str` +* user : :ref:`Str` +* no_user : :ref:`Str` +* group : :ref:`Str` +* no_group : :ref:`Str` +* host : :ref:`Str` +* no_host : :ref:`Str` +* hostgroup : :ref:`Str` +* no_hostgroup : :ref:`Str` +* in_netgroup : :ref:`Str` +* not_in_netgroup : :ref:`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 \ No newline at end of file diff --git a/doc/api/netgroup_mod.md b/doc/api/netgroup_mod.md new file mode 100644 index 000000000..85d35c54a --- /dev/null +++ b/doc/api/netgroup_mod.md @@ -0,0 +1,43 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# netgroup_mod +Modify a netgroup. + +### Arguments +|Name|Type|Required +|-|-|- +|cn|:ref:`Str`|True + +### Options +* rights : :ref:`Flag` **(Required)** + * Default: False +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* no_members : :ref:`Flag` **(Required)** + * Default: False +* description : :ref:`Str` +* nisdomainname : :ref:`Str` +* usercategory : :ref:`StrEnum` + * Values: ('all',) +* hostcategory : :ref:`StrEnum` + * Values: ('all',) +* externalhost : :ref:`Str` +* setattr : :ref:`Str` +* addattr : :ref:`Str` +* delattr : :ref:`Str` +* version : :ref:`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 \ No newline at end of file diff --git a/doc/api/netgroup_remove_member.md b/doc/api/netgroup_remove_member.md new file mode 100644 index 000000000..f5a03a3f3 --- /dev/null +++ b/doc/api/netgroup_remove_member.md @@ -0,0 +1,36 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# netgroup_remove_member +Remove members from a netgroup. + +### Arguments +|Name|Type|Required +|-|-|- +|cn|:ref:`Str`|True + +### Options +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* no_members : :ref:`Flag` **(Required)** + * Default: False +* version : :ref:`Str` +* user : :ref:`Str` +* group : :ref:`Str` +* host : :ref:`Str` +* hostgroup : :ref:`Str` +* netgroup : :ref:`Str` + +### Output +|Name|Type +|-|- +|completed|Output +|failed|Output +|result|Entry + +[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end) +### Semantics + +### Notes + +### Version differences \ No newline at end of file diff --git a/doc/api/netgroup_show.md b/doc/api/netgroup_show.md new file mode 100644 index 000000000..7765422c2 --- /dev/null +++ b/doc/api/netgroup_show.md @@ -0,0 +1,33 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# netgroup_show +Display information about a netgroup. + +### Arguments +|Name|Type|Required +|-|-|- +|cn|:ref:`Str`|True + +### Options +* rights : :ref:`Flag` **(Required)** + * Default: False +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* no_members : :ref:`Flag` **(Required)** + * Default: False +* version : :ref:`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 \ No newline at end of file diff --git a/doc/api/otpconfig_mod.md b/doc/api/otpconfig_mod.md new file mode 100644 index 000000000..1e21f2d1a --- /dev/null +++ b/doc/api/otpconfig_mod.md @@ -0,0 +1,36 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# otpconfig_mod +Modify OTP configuration options. + +### Arguments +No arguments. + +### Options +* rights : :ref:`Flag` **(Required)** + * Default: False +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* ipatokentotpauthwindow : :ref:`Int` +* ipatokentotpsyncwindow : :ref:`Int` +* ipatokenhotpauthwindow : :ref:`Int` +* ipatokenhotpsyncwindow : :ref:`Int` +* setattr : :ref:`Str` +* addattr : :ref:`Str` +* delattr : :ref:`Str` +* version : :ref:`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 \ No newline at end of file diff --git a/doc/api/otpconfig_show.md b/doc/api/otpconfig_show.md new file mode 100644 index 000000000..9bd4fda65 --- /dev/null +++ b/doc/api/otpconfig_show.md @@ -0,0 +1,29 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# otpconfig_show +Show the current OTP configuration. + +### Arguments +No arguments. + +### Options +* rights : :ref:`Flag` **(Required)** + * Default: False +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* version : :ref:`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 \ No newline at end of file diff --git a/doc/api/otptoken_add.md b/doc/api/otptoken_add.md new file mode 100644 index 000000000..0f43c88c0 --- /dev/null +++ b/doc/api/otptoken_add.md @@ -0,0 +1,61 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# otptoken_add +Add a new OTP token. + +### Arguments +|Name|Type|Required +|-|-|- +|ipatokenuniqueid|:ref:`Str`|False + +### Options +* no_qrcode : :ref:`Flag` **(Required)** + * Default: False +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* no_members : :ref:`Flag` **(Required)** + * Default: False +* type : :ref:`StrEnum` + * Default: totp + * Values: ('totp', 'hotp', 'TOTP', 'HOTP') +* description : :ref:`Str` +* ipatokenowner : :ref:`Str` +* ipatokendisabled : :ref:`Bool` +* ipatokennotbefore : :ref:`DateTime` +* ipatokennotafter : :ref:`DateTime` +* ipatokenvendor : :ref:`Str` +* ipatokenmodel : :ref:`Str` +* ipatokenserial : :ref:`Str` +* ipatokenotpkey : :ref:`OTPTokenKey` +* ipatokenotpalgorithm : :ref:`StrEnum` + * Default: sha1 + * Values: ('sha1', 'sha256', 'sha384', 'sha512') +* ipatokenotpdigits : :ref:`IntEnum` + * Default: 6 + * Values: (6, 8) +* ipatokentotpclockoffset : :ref:`Int` + * Default: 0 +* ipatokentotptimestep : :ref:`Int` + * Default: 30 +* ipatokenhotpcounter : :ref:`Int` + * Default: 0 +* setattr : :ref:`Str` +* addattr : :ref:`Str` +* qrcode : :ref:`Flag` + * Default: False +* version : :ref:`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 \ No newline at end of file diff --git a/doc/api/otptoken_add_managedby.md b/doc/api/otptoken_add_managedby.md new file mode 100644 index 000000000..dcf02f834 --- /dev/null +++ b/doc/api/otptoken_add_managedby.md @@ -0,0 +1,32 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# otptoken_add_managedby +Add users that can manage this token. + +### Arguments +|Name|Type|Required +|-|-|- +|ipatokenuniqueid|:ref:`Str`|True + +### Options +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* no_members : :ref:`Flag` **(Required)** + * Default: False +* version : :ref:`Str` +* user : :ref:`Str` + +### Output +|Name|Type +|-|- +|completed|Output +|failed|Output +|result|Entry + +[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end) +### Semantics + +### Notes + +### Version differences \ No newline at end of file diff --git a/doc/api/otptoken_del.md b/doc/api/otptoken_del.md new file mode 100644 index 000000000..9557a6c6b --- /dev/null +++ b/doc/api/otptoken_del.md @@ -0,0 +1,27 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# otptoken_del +Delete an OTP token. + +### Arguments +|Name|Type|Required +|-|-|- +|ipatokenuniqueid|:ref:`Str`|True + +### Options +* continue : :ref:`Flag` **(Required)** + * Default: False +* version : :ref:`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 \ No newline at end of file diff --git a/doc/api/otptoken_find.md b/doc/api/otptoken_find.md new file mode 100644 index 000000000..0f33b0665 --- /dev/null +++ b/doc/api/otptoken_find.md @@ -0,0 +1,60 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# otptoken_find +Search for OTP token. + +### Arguments +|Name|Type|Required +|-|-|- +|criteria|:ref:`Str`|False + +### Options +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* no_members : :ref:`Flag` **(Required)** + * Default: True +* ipatokenuniqueid : :ref:`Str` +* type : :ref:`StrEnum` + * Default: totp + * Values: ('totp', 'hotp', 'TOTP', 'HOTP') +* description : :ref:`Str` +* ipatokenowner : :ref:`Str` +* ipatokendisabled : :ref:`Bool` +* ipatokennotbefore : :ref:`DateTime` +* ipatokennotafter : :ref:`DateTime` +* ipatokenvendor : :ref:`Str` +* ipatokenmodel : :ref:`Str` +* ipatokenserial : :ref:`Str` +* ipatokenotpalgorithm : :ref:`StrEnum` + * Default: sha1 + * Values: ('sha1', 'sha256', 'sha384', 'sha512') +* ipatokenotpdigits : :ref:`IntEnum` + * Default: 6 + * Values: (6, 8) +* ipatokentotpclockoffset : :ref:`Int` + * Default: 0 +* ipatokentotptimestep : :ref:`Int` + * Default: 30 +* ipatokenhotpcounter : :ref:`Int` + * Default: 0 +* timelimit : :ref:`Int` +* sizelimit : :ref:`Int` +* version : :ref:`Str` +* pkey_only : :ref:`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 \ No newline at end of file diff --git a/doc/api/otptoken_mod.md b/doc/api/otptoken_mod.md new file mode 100644 index 000000000..8d1626044 --- /dev/null +++ b/doc/api/otptoken_mod.md @@ -0,0 +1,45 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# otptoken_mod +Modify a OTP token. + +### Arguments +|Name|Type|Required +|-|-|- +|ipatokenuniqueid|:ref:`Str`|True + +### Options +* rights : :ref:`Flag` **(Required)** + * Default: False +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* no_members : :ref:`Flag` **(Required)** + * Default: False +* description : :ref:`Str` +* ipatokenowner : :ref:`Str` +* ipatokendisabled : :ref:`Bool` +* ipatokennotbefore : :ref:`DateTime` +* ipatokennotafter : :ref:`DateTime` +* ipatokenvendor : :ref:`Str` +* ipatokenmodel : :ref:`Str` +* ipatokenserial : :ref:`Str` +* setattr : :ref:`Str` +* addattr : :ref:`Str` +* delattr : :ref:`Str` +* version : :ref:`Str` +* rename : :ref:`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 \ No newline at end of file diff --git a/doc/api/otptoken_remove_managedby.md b/doc/api/otptoken_remove_managedby.md new file mode 100644 index 000000000..0f2815c70 --- /dev/null +++ b/doc/api/otptoken_remove_managedby.md @@ -0,0 +1,32 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# otptoken_remove_managedby +Remove users that can manage this token. + +### Arguments +|Name|Type|Required +|-|-|- +|ipatokenuniqueid|:ref:`Str`|True + +### Options +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* no_members : :ref:`Flag` **(Required)** + * Default: False +* version : :ref:`Str` +* user : :ref:`Str` + +### Output +|Name|Type +|-|- +|completed|Output +|failed|Output +|result|Entry + +[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end) +### Semantics + +### Notes + +### Version differences \ No newline at end of file diff --git a/doc/api/otptoken_show.md b/doc/api/otptoken_show.md new file mode 100644 index 000000000..a318eae3d --- /dev/null +++ b/doc/api/otptoken_show.md @@ -0,0 +1,33 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# otptoken_show +Display information about an OTP token. + +### Arguments +|Name|Type|Required +|-|-|- +|ipatokenuniqueid|:ref:`Str`|True + +### Options +* rights : :ref:`Flag` **(Required)** + * Default: False +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* no_members : :ref:`Flag` **(Required)** + * Default: False +* version : :ref:`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 \ No newline at end of file diff --git a/doc/api/output_find.md b/doc/api/output_find.md new file mode 100644 index 000000000..22bb6e288 --- /dev/null +++ b/doc/api/output_find.md @@ -0,0 +1,33 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# output_find +Search for command outputs. + +### Arguments +|Name|Type|Required +|-|-|- +|commandfull_name|:ref:`Str`|True +|criteria|:ref:`Str`|False + +### Options +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* version : :ref:`Str` +* pkey_only : :ref:`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 \ No newline at end of file diff --git a/doc/api/output_show.md b/doc/api/output_show.md new file mode 100644 index 000000000..56598fe08 --- /dev/null +++ b/doc/api/output_show.md @@ -0,0 +1,30 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# output_show +Display information about a command output. + +### Arguments +|Name|Type|Required +|-|-|- +|commandfull_name|:ref:`Str`|True +|name|:ref:`Str`|True + +### Options +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* version : :ref:`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 \ No newline at end of file diff --git a/doc/api/param_find.md b/doc/api/param_find.md new file mode 100644 index 000000000..70f2fd2a6 --- /dev/null +++ b/doc/api/param_find.md @@ -0,0 +1,33 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# param_find +Search command parameters. + +### Arguments +|Name|Type|Required +|-|-|- +|metaobjectfull_name|:ref:`Str`|True +|criteria|:ref:`Str`|False + +### Options +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* version : :ref:`Str` +* pkey_only : :ref:`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 \ No newline at end of file diff --git a/doc/api/param_show.md b/doc/api/param_show.md new file mode 100644 index 000000000..1131a0544 --- /dev/null +++ b/doc/api/param_show.md @@ -0,0 +1,30 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# param_show +Display information about a command parameter. + +### Arguments +|Name|Type|Required +|-|-|- +|metaobjectfull_name|:ref:`Str`|True +|name|:ref:`Str`|True + +### Options +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* version : :ref:`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 \ No newline at end of file diff --git a/doc/api/parameters.rst b/doc/api/parameters.rst new file mode 100644 index 000000000..802ec6ef1 --- /dev/null +++ b/doc/api/parameters.rst @@ -0,0 +1,72 @@ +IPA API Parameter types +======================= +.. toctree:: + :maxdepth: 1 + + + A6Record.md + AAAARecord.md + AFSDBRecord.md + APLRecord.md + ARecord.md + AccessTime.md + Any.md + BinaryFile.md + Bool.md + Bytes.md + BytesEnum.md + CERTRecord.md + CNAMERecord.md + Certificate.md + CertificateSigningRequest.md + DHCIDRecord.md + DLVRecord.md + DNAMERecord.md + DNOrURL.md + DNParam.md + DNSNameParam.md + DNSRecord.md + DSRecord.md + Data.md + DateTime.md + Decimal.md + Dict.md + Enum.md + File.md + Flag.md + ForwardRecord.md + HINFORecord.md + HIPRecord.md + HostPassword.md + IA5Str.md + IPSECKEYRecord.md + Int.md + IntEnum.md + KEYRecord.md + KXRecord.md + LOCRecord.md + MDRecord.md + MINFORecord.md + MXRecord.md + NAPTRRecord.md + NSECRecord.md + NSRecord.md + NXTRecord.md + Number.md + OTPTokenKey.md + PTRRecord.md + Password.md + Principal.md + RPRecord.md + RRSIGRecord.md + SIGRecord.md + SPFRecord.md + SRVRecord.md + SSHFPRecord.md + SerialNumber.md + Str.md + StrEnum.md + TLSARecord.md + TXTRecord.md + URIRecord.md + UnsupportedDNSRecord.md \ No newline at end of file diff --git a/doc/api/passwd.md b/doc/api/passwd.md new file mode 100644 index 000000000..35277fecc --- /dev/null +++ b/doc/api/passwd.md @@ -0,0 +1,28 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# passwd +Set a user's password. + +### Arguments +|Name|Type|Required +|-|-|- +|principal|:ref:`Principal`|True +|password|:ref:`Password`|True +|current_password|:ref:`Password`|True + +### Options +* otp : :ref:`Password` +* version : :ref:`Str` + +### Output +|Name|Type +|-|- +|result|Output +|summary|Output +|value|Output + +[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end) +### Semantics + +### Notes + +### Version differences \ No newline at end of file diff --git a/doc/api/permission_add.md b/doc/api/permission_add.md new file mode 100644 index 000000000..06a0a89bf --- /dev/null +++ b/doc/api/permission_add.md @@ -0,0 +1,51 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# permission_add +Add a new permission. + +### Arguments +|Name|Type|Required +|-|-|- +|cn|:ref:`Str`|True + +### Options +* ipapermbindruletype : :ref:`StrEnum` **(Required)** + * Default: permission + * Values: ('permission', 'all', 'anonymous', 'self') +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* no_members : :ref:`Flag` **(Required)** + * Default: False +* ipapermright : :ref:`StrEnum` + * Values: ('read', 'search', 'compare', 'write', 'add', 'delete', 'all') +* attrs : :ref:`Str` +* ipapermlocation : :ref:`DNOrURL` +* extratargetfilter : :ref:`Str` +* ipapermtargetfilter : :ref:`Str` +* ipapermtarget : :ref:`DNParam` +* ipapermtargetto : :ref:`DNParam` +* ipapermtargetfrom : :ref:`DNParam` +* memberof : :ref:`Str` +* targetgroup : :ref:`Str` +* type : :ref:`Str` +* permissions : :ref:`Str` +* filter : :ref:`Str` +* subtree : :ref:`Str` +* setattr : :ref:`Str` +* addattr : :ref:`Str` +* version : :ref:`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 \ No newline at end of file diff --git a/doc/api/permission_add_member.md b/doc/api/permission_add_member.md new file mode 100644 index 000000000..9ca36c666 --- /dev/null +++ b/doc/api/permission_add_member.md @@ -0,0 +1,32 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# permission_add_member +Add members to a permission. + +### Arguments +|Name|Type|Required +|-|-|- +|cn|:ref:`Str`|True + +### Options +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* no_members : :ref:`Flag` **(Required)** + * Default: False +* version : :ref:`Str` +* privilege : :ref:`Str` + +### Output +|Name|Type +|-|- +|completed|Output +|failed|Output +|result|Entry + +[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end) +### Semantics + +### Notes + +### Version differences \ No newline at end of file diff --git a/doc/api/permission_add_noaci.md b/doc/api/permission_add_noaci.md new file mode 100644 index 000000000..5fa339605 --- /dev/null +++ b/doc/api/permission_add_noaci.md @@ -0,0 +1,32 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# permission_add_noaci +Add a system permission without an ACI (internal command) + +### Arguments +|Name|Type|Required +|-|-|- +|cn|:ref:`Str`|True + +### Options +* ipapermissiontype : :ref:`Str` **(Required)** +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* no_members : :ref:`Flag` **(Required)** + * Default: False +* version : :ref:`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 \ No newline at end of file diff --git a/doc/api/permission_del.md b/doc/api/permission_del.md new file mode 100644 index 000000000..3ca7bb518 --- /dev/null +++ b/doc/api/permission_del.md @@ -0,0 +1,29 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# permission_del +Delete a permission. + +### Arguments +|Name|Type|Required +|-|-|- +|cn|:ref:`Str`|True + +### Options +* continue : :ref:`Flag` **(Required)** + * Default: False +* force : :ref:`Flag` **(Required)** + * Default: False +* version : :ref:`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 \ No newline at end of file diff --git a/doc/api/permission_find.md b/doc/api/permission_find.md new file mode 100644 index 000000000..513e94bde --- /dev/null +++ b/doc/api/permission_find.md @@ -0,0 +1,58 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# permission_find +Search for permissions. + +### Arguments +|Name|Type|Required +|-|-|- +|criteria|:ref:`Str`|False + +### Options +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* no_members : :ref:`Flag` **(Required)** + * Default: True +* cn : :ref:`Str` +* ipapermright : :ref:`StrEnum` + * Values: ('read', 'search', 'compare', 'write', 'add', 'delete', 'all') +* attrs : :ref:`Str` +* ipapermincludedattr : :ref:`Str` +* ipapermexcludedattr : :ref:`Str` +* ipapermdefaultattr : :ref:`Str` +* ipapermbindruletype : :ref:`StrEnum` + * Default: permission + * Values: ('permission', 'all', 'anonymous', 'self') +* ipapermlocation : :ref:`DNOrURL` +* extratargetfilter : :ref:`Str` +* ipapermtargetfilter : :ref:`Str` +* ipapermtarget : :ref:`DNParam` +* ipapermtargetto : :ref:`DNParam` +* ipapermtargetfrom : :ref:`DNParam` +* memberof : :ref:`Str` +* targetgroup : :ref:`Str` +* type : :ref:`Str` +* permissions : :ref:`Str` +* filter : :ref:`Str` +* subtree : :ref:`Str` +* timelimit : :ref:`Int` +* sizelimit : :ref:`Int` +* version : :ref:`Str` +* pkey_only : :ref:`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 \ No newline at end of file diff --git a/doc/api/permission_mod.md b/doc/api/permission_mod.md new file mode 100644 index 000000000..2c7c0e052 --- /dev/null +++ b/doc/api/permission_mod.md @@ -0,0 +1,57 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# permission_mod +Modify a permission. + +### Arguments +|Name|Type|Required +|-|-|- +|cn|:ref:`Str`|True + +### Options +* rights : :ref:`Flag` **(Required)** + * Default: False +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* no_members : :ref:`Flag` **(Required)** + * Default: False +* ipapermright : :ref:`StrEnum` + * Values: ('read', 'search', 'compare', 'write', 'add', 'delete', 'all') +* attrs : :ref:`Str` +* ipapermincludedattr : :ref:`Str` +* ipapermexcludedattr : :ref:`Str` +* ipapermbindruletype : :ref:`StrEnum` + * Default: permission + * Values: ('permission', 'all', 'anonymous', 'self') +* ipapermlocation : :ref:`DNOrURL` +* extratargetfilter : :ref:`Str` +* ipapermtargetfilter : :ref:`Str` +* ipapermtarget : :ref:`DNParam` +* ipapermtargetto : :ref:`DNParam` +* ipapermtargetfrom : :ref:`DNParam` +* memberof : :ref:`Str` +* targetgroup : :ref:`Str` +* type : :ref:`Str` +* permissions : :ref:`Str` +* filter : :ref:`Str` +* subtree : :ref:`Str` +* setattr : :ref:`Str` +* addattr : :ref:`Str` +* delattr : :ref:`Str` +* version : :ref:`Str` +* rename : :ref:`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 \ No newline at end of file diff --git a/doc/api/permission_remove_member.md b/doc/api/permission_remove_member.md new file mode 100644 index 000000000..83928e4bc --- /dev/null +++ b/doc/api/permission_remove_member.md @@ -0,0 +1,32 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# permission_remove_member +Remove members from a permission. + +### Arguments +|Name|Type|Required +|-|-|- +|cn|:ref:`Str`|True + +### Options +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* no_members : :ref:`Flag` **(Required)** + * Default: False +* version : :ref:`Str` +* privilege : :ref:`Str` + +### Output +|Name|Type +|-|- +|completed|Output +|failed|Output +|result|Entry + +[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end) +### Semantics + +### Notes + +### Version differences \ No newline at end of file diff --git a/doc/api/permission_show.md b/doc/api/permission_show.md new file mode 100644 index 000000000..60e8c238b --- /dev/null +++ b/doc/api/permission_show.md @@ -0,0 +1,33 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# permission_show +Display information about a permission. + +### Arguments +|Name|Type|Required +|-|-|- +|cn|:ref:`Str`|True + +### Options +* rights : :ref:`Flag` **(Required)** + * Default: False +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* no_members : :ref:`Flag` **(Required)** + * Default: False +* version : :ref:`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 \ No newline at end of file diff --git a/doc/api/ping.md b/doc/api/ping.md new file mode 100644 index 000000000..4a5ce6e1c --- /dev/null +++ b/doc/api/ping.md @@ -0,0 +1,21 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# ping +Ping a remote server. + +### Arguments +No arguments. + +### Options +* version : :ref:`Str` + +### Output +|Name|Type +|-|- +|summary|Output + +[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end) +### Semantics + +### Notes + +### Version differences \ No newline at end of file diff --git a/doc/api/pkinit_status.md b/doc/api/pkinit_status.md new file mode 100644 index 000000000..1525a5f15 --- /dev/null +++ b/doc/api/pkinit_status.md @@ -0,0 +1,35 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# pkinit_status +Report PKINIT status on the IPA masters + +### Arguments +|Name|Type|Required +|-|-|- +|criteria|:ref:`Str`|False + +### Options +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* server_server : :ref:`Str` +* status : :ref:`StrEnum` + * Values: ('enabled', 'disabled') +* timelimit : :ref:`Int` +* sizelimit : :ref:`Int` +* version : :ref:`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 \ No newline at end of file diff --git a/doc/api/plugins.md b/doc/api/plugins.md new file mode 100644 index 000000000..5d5ac949e --- /dev/null +++ b/doc/api/plugins.md @@ -0,0 +1,27 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# plugins +Show all loaded plugins. + +### Arguments +No arguments. + +### Options +* all : :ref:`Flag` **(Required)** + * Default: True +* server : :ref:`Flag` + * Default: False +* version : :ref:`Str` + +### Output +|Name|Type +|-|- +|count|Output +|result|Output +|summary|Output + +[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end) +### Semantics + +### Notes + +### Version differences \ No newline at end of file diff --git a/doc/api/privilege_add.md b/doc/api/privilege_add.md new file mode 100644 index 000000000..21797c01a --- /dev/null +++ b/doc/api/privilege_add.md @@ -0,0 +1,34 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# privilege_add +Add a new privilege. + +### Arguments +|Name|Type|Required +|-|-|- +|cn|:ref:`Str`|True + +### Options +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* no_members : :ref:`Flag` **(Required)** + * Default: False +* description : :ref:`Str` +* setattr : :ref:`Str` +* addattr : :ref:`Str` +* version : :ref:`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 \ No newline at end of file diff --git a/doc/api/privilege_add_member.md b/doc/api/privilege_add_member.md new file mode 100644 index 000000000..83766a70e --- /dev/null +++ b/doc/api/privilege_add_member.md @@ -0,0 +1,32 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# privilege_add_member +Add members to a privilege. + +### Arguments +|Name|Type|Required +|-|-|- +|cn|:ref:`Str`|True + +### Options +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* no_members : :ref:`Flag` **(Required)** + * Default: False +* version : :ref:`Str` +* role : :ref:`Str` + +### Output +|Name|Type +|-|- +|completed|Output +|failed|Output +|result|Entry + +[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end) +### Semantics + +### Notes + +### Version differences \ No newline at end of file diff --git a/doc/api/privilege_add_permission.md b/doc/api/privilege_add_permission.md new file mode 100644 index 000000000..326080215 --- /dev/null +++ b/doc/api/privilege_add_permission.md @@ -0,0 +1,32 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# privilege_add_permission +Add permissions to a privilege. + +### Arguments +|Name|Type|Required +|-|-|- +|cn|:ref:`Str`|True + +### Options +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* no_members : :ref:`Flag` **(Required)** + * Default: False +* version : :ref:`Str` +* permission : :ref:`Str` + +### Output +|Name|Type +|-|- +|completed|Output +|failed|Output +|result|Entry + +[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end) +### Semantics + +### Notes + +### Version differences \ No newline at end of file diff --git a/doc/api/privilege_del.md b/doc/api/privilege_del.md new file mode 100644 index 000000000..a5eee43aa --- /dev/null +++ b/doc/api/privilege_del.md @@ -0,0 +1,27 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# privilege_del +Delete a privilege. + +### Arguments +|Name|Type|Required +|-|-|- +|cn|:ref:`Str`|True + +### Options +* continue : :ref:`Flag` **(Required)** + * Default: False +* version : :ref:`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 \ No newline at end of file diff --git a/doc/api/privilege_find.md b/doc/api/privilege_find.md new file mode 100644 index 000000000..9cdec6ef2 --- /dev/null +++ b/doc/api/privilege_find.md @@ -0,0 +1,38 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# privilege_find +Search for privileges. + +### Arguments +|Name|Type|Required +|-|-|- +|criteria|:ref:`Str`|False + +### Options +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* no_members : :ref:`Flag` **(Required)** + * Default: True +* cn : :ref:`Str` +* description : :ref:`Str` +* timelimit : :ref:`Int` +* sizelimit : :ref:`Int` +* version : :ref:`Str` +* pkey_only : :ref:`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 \ No newline at end of file diff --git a/doc/api/privilege_mod.md b/doc/api/privilege_mod.md new file mode 100644 index 000000000..52a0a37da --- /dev/null +++ b/doc/api/privilege_mod.md @@ -0,0 +1,38 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# privilege_mod +Modify a privilege. + +### Arguments +|Name|Type|Required +|-|-|- +|cn|:ref:`Str`|True + +### Options +* rights : :ref:`Flag` **(Required)** + * Default: False +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* no_members : :ref:`Flag` **(Required)** + * Default: False +* description : :ref:`Str` +* setattr : :ref:`Str` +* addattr : :ref:`Str` +* delattr : :ref:`Str` +* version : :ref:`Str` +* rename : :ref:`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 \ No newline at end of file diff --git a/doc/api/privilege_remove_member.md b/doc/api/privilege_remove_member.md new file mode 100644 index 000000000..2331bf5e7 --- /dev/null +++ b/doc/api/privilege_remove_member.md @@ -0,0 +1,32 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# privilege_remove_member +Remove members from a privilege + +### Arguments +|Name|Type|Required +|-|-|- +|cn|:ref:`Str`|True + +### Options +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* no_members : :ref:`Flag` **(Required)** + * Default: False +* version : :ref:`Str` +* role : :ref:`Str` + +### Output +|Name|Type +|-|- +|completed|Output +|failed|Output +|result|Entry + +[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end) +### Semantics + +### Notes + +### Version differences \ No newline at end of file diff --git a/doc/api/privilege_remove_permission.md b/doc/api/privilege_remove_permission.md new file mode 100644 index 000000000..7e70a76da --- /dev/null +++ b/doc/api/privilege_remove_permission.md @@ -0,0 +1,32 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# privilege_remove_permission +Remove permissions from a privilege. + +### Arguments +|Name|Type|Required +|-|-|- +|cn|:ref:`Str`|True + +### Options +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* no_members : :ref:`Flag` **(Required)** + * Default: False +* version : :ref:`Str` +* permission : :ref:`Str` + +### Output +|Name|Type +|-|- +|completed|Output +|failed|Output +|result|Entry + +[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end) +### Semantics + +### Notes + +### Version differences \ No newline at end of file diff --git a/doc/api/privilege_show.md b/doc/api/privilege_show.md new file mode 100644 index 000000000..db577c247 --- /dev/null +++ b/doc/api/privilege_show.md @@ -0,0 +1,33 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# privilege_show +Display information about a privilege. + +### Arguments +|Name|Type|Required +|-|-|- +|cn|:ref:`Str`|True + +### Options +* rights : :ref:`Flag` **(Required)** + * Default: False +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* no_members : :ref:`Flag` **(Required)** + * Default: False +* version : :ref:`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 \ No newline at end of file diff --git a/doc/api/pwpolicy_add.md b/doc/api/pwpolicy_add.md new file mode 100644 index 000000000..77319754a --- /dev/null +++ b/doc/api/pwpolicy_add.md @@ -0,0 +1,50 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# pwpolicy_add +Add a new group password policy. + +### Arguments +|Name|Type|Required +|-|-|- +|cn|:ref:`Str`|True + +### Options +* cospriority : :ref:`Int` **(Required)** +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* krbmaxpwdlife : :ref:`Int` +* krbminpwdlife : :ref:`Int` +* krbpwdhistorylength : :ref:`Int` +* krbpwdmindiffchars : :ref:`Int` +* krbpwdminlength : :ref:`Int` +* krbpwdmaxfailure : :ref:`Int` +* krbpwdfailurecountinterval : :ref:`Int` +* krbpwdlockoutduration : :ref:`Int` +* ipapwdmaxrepeat : :ref:`Int` + * Default: 0 +* ipapwdmaxsequence : :ref:`Int` + * Default: 0 +* ipapwddictcheck : :ref:`Bool` + * Default: False +* ipapwdusercheck : :ref:`Bool` + * Default: False +* passwordgracelimit : :ref:`Int` + * Default: -1 +* setattr : :ref:`Str` +* addattr : :ref:`Str` +* version : :ref:`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 \ No newline at end of file diff --git a/doc/api/pwpolicy_del.md b/doc/api/pwpolicy_del.md new file mode 100644 index 000000000..54f4db4f4 --- /dev/null +++ b/doc/api/pwpolicy_del.md @@ -0,0 +1,27 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# pwpolicy_del +Delete a group password policy. + +### Arguments +|Name|Type|Required +|-|-|- +|cn|:ref:`Str`|True + +### Options +* continue : :ref:`Flag` **(Required)** + * Default: False +* version : :ref:`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 \ No newline at end of file diff --git a/doc/api/pwpolicy_find.md b/doc/api/pwpolicy_find.md new file mode 100644 index 000000000..0c7ecb5d1 --- /dev/null +++ b/doc/api/pwpolicy_find.md @@ -0,0 +1,54 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# pwpolicy_find +Search for group password policies. + +### Arguments +|Name|Type|Required +|-|-|- +|criteria|:ref:`Str`|False + +### Options +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* cn : :ref:`Str` +* krbmaxpwdlife : :ref:`Int` +* krbminpwdlife : :ref:`Int` +* krbpwdhistorylength : :ref:`Int` +* krbpwdmindiffchars : :ref:`Int` +* krbpwdminlength : :ref:`Int` +* cospriority : :ref:`Int` +* krbpwdmaxfailure : :ref:`Int` +* krbpwdfailurecountinterval : :ref:`Int` +* krbpwdlockoutduration : :ref:`Int` +* ipapwdmaxrepeat : :ref:`Int` + * Default: 0 +* ipapwdmaxsequence : :ref:`Int` + * Default: 0 +* ipapwddictcheck : :ref:`Bool` + * Default: False +* ipapwdusercheck : :ref:`Bool` + * Default: False +* passwordgracelimit : :ref:`Int` + * Default: -1 +* timelimit : :ref:`Int` +* sizelimit : :ref:`Int` +* version : :ref:`Str` +* pkey_only : :ref:`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 \ No newline at end of file diff --git a/doc/api/pwpolicy_mod.md b/doc/api/pwpolicy_mod.md new file mode 100644 index 000000000..723212278 --- /dev/null +++ b/doc/api/pwpolicy_mod.md @@ -0,0 +1,53 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# pwpolicy_mod +Modify a group password policy. + +### Arguments +|Name|Type|Required +|-|-|- +|cn|:ref:`Str`|False + +### Options +* rights : :ref:`Flag` **(Required)** + * Default: False +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* krbmaxpwdlife : :ref:`Int` +* krbminpwdlife : :ref:`Int` +* krbpwdhistorylength : :ref:`Int` +* krbpwdmindiffchars : :ref:`Int` +* krbpwdminlength : :ref:`Int` +* cospriority : :ref:`Int` +* krbpwdmaxfailure : :ref:`Int` +* krbpwdfailurecountinterval : :ref:`Int` +* krbpwdlockoutduration : :ref:`Int` +* ipapwdmaxrepeat : :ref:`Int` + * Default: 0 +* ipapwdmaxsequence : :ref:`Int` + * Default: 0 +* ipapwddictcheck : :ref:`Bool` + * Default: False +* ipapwdusercheck : :ref:`Bool` + * Default: False +* passwordgracelimit : :ref:`Int` + * Default: -1 +* setattr : :ref:`Str` +* addattr : :ref:`Str` +* delattr : :ref:`Str` +* version : :ref:`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 \ No newline at end of file diff --git a/doc/api/pwpolicy_show.md b/doc/api/pwpolicy_show.md new file mode 100644 index 000000000..fc44d7836 --- /dev/null +++ b/doc/api/pwpolicy_show.md @@ -0,0 +1,32 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# pwpolicy_show +Display information about password policy. + +### Arguments +|Name|Type|Required +|-|-|- +|cn|:ref:`Str`|False + +### Options +* rights : :ref:`Flag` **(Required)** + * Default: False +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* user : :ref:`Str` +* version : :ref:`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 \ No newline at end of file diff --git a/doc/api/radiusproxy_add.md b/doc/api/radiusproxy_add.md new file mode 100644 index 000000000..cba4e2f4e --- /dev/null +++ b/doc/api/radiusproxy_add.md @@ -0,0 +1,37 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# radiusproxy_add +Add a new RADIUS proxy server. + +### Arguments +|Name|Type|Required +|-|-|- +|cn|:ref:`Str`|True + +### Options +* ipatokenradiusserver : :ref:`Str` **(Required)** +* ipatokenradiussecret : :ref:`Password` **(Required)** +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* description : :ref:`Str` +* ipatokenradiustimeout : :ref:`Int` +* ipatokenradiusretries : :ref:`Int` +* ipatokenusermapattribute : :ref:`Str` +* setattr : :ref:`Str` +* addattr : :ref:`Str` +* version : :ref:`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 \ No newline at end of file diff --git a/doc/api/radiusproxy_del.md b/doc/api/radiusproxy_del.md new file mode 100644 index 000000000..885f71b98 --- /dev/null +++ b/doc/api/radiusproxy_del.md @@ -0,0 +1,27 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# radiusproxy_del +Delete a RADIUS proxy server. + +### Arguments +|Name|Type|Required +|-|-|- +|cn|:ref:`Str`|True + +### Options +* continue : :ref:`Flag` **(Required)** + * Default: False +* version : :ref:`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 \ No newline at end of file diff --git a/doc/api/radiusproxy_find.md b/doc/api/radiusproxy_find.md new file mode 100644 index 000000000..7fb47b47e --- /dev/null +++ b/doc/api/radiusproxy_find.md @@ -0,0 +1,41 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# radiusproxy_find +Search for RADIUS proxy servers. + +### Arguments +|Name|Type|Required +|-|-|- +|criteria|:ref:`Str`|False + +### Options +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* cn : :ref:`Str` +* description : :ref:`Str` +* ipatokenradiusserver : :ref:`Str` +* ipatokenradiussecret : :ref:`Password` +* ipatokenradiustimeout : :ref:`Int` +* ipatokenradiusretries : :ref:`Int` +* ipatokenusermapattribute : :ref:`Str` +* timelimit : :ref:`Int` +* sizelimit : :ref:`Int` +* version : :ref:`Str` +* pkey_only : :ref:`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 \ No newline at end of file diff --git a/doc/api/radiusproxy_mod.md b/doc/api/radiusproxy_mod.md new file mode 100644 index 000000000..88134ec3c --- /dev/null +++ b/doc/api/radiusproxy_mod.md @@ -0,0 +1,41 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# radiusproxy_mod +Modify a RADIUS proxy server. + +### Arguments +|Name|Type|Required +|-|-|- +|cn|:ref:`Str`|True + +### Options +* rights : :ref:`Flag` **(Required)** + * Default: False +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* description : :ref:`Str` +* ipatokenradiusserver : :ref:`Str` +* ipatokenradiussecret : :ref:`Password` +* ipatokenradiustimeout : :ref:`Int` +* ipatokenradiusretries : :ref:`Int` +* ipatokenusermapattribute : :ref:`Str` +* setattr : :ref:`Str` +* addattr : :ref:`Str` +* delattr : :ref:`Str` +* version : :ref:`Str` +* rename : :ref:`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 \ No newline at end of file diff --git a/doc/api/radiusproxy_show.md b/doc/api/radiusproxy_show.md new file mode 100644 index 000000000..48ff9eb55 --- /dev/null +++ b/doc/api/radiusproxy_show.md @@ -0,0 +1,31 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# radiusproxy_show +Display information about a RADIUS proxy server. + +### Arguments +|Name|Type|Required +|-|-|- +|cn|:ref:`Str`|True + +### Options +* rights : :ref:`Flag` **(Required)** + * Default: False +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* version : :ref:`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 \ No newline at end of file diff --git a/doc/api/realmdomains_mod.md b/doc/api/realmdomains_mod.md new file mode 100644 index 000000000..bdb95a330 --- /dev/null +++ b/doc/api/realmdomains_mod.md @@ -0,0 +1,50 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# realmdomains_mod + +Modify realm domains + +DNS check: When manually adding a domain to the list, a DNS check is +performed by default. It ensures that the domain is associated with +the IPA realm, by checking whether the domain has a _kerberos TXT record +containing the IPA realm name. This check can be skipped by specifying +--force option. + +Removal: when a realm domain which has a matching DNS zone managed by +IPA is being removed, a corresponding _kerberos TXT record in the zone is +removed automatically as well. Other records in the zone or the zone +itself are not affected. + + +### Arguments +No arguments. + +### Options +* rights : :ref:`Flag` **(Required)** + * Default: False +* force : :ref:`Flag` **(Required)** + * Default: False +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* associateddomain : :ref:`Str` +* add_domain : :ref:`Str` +* del_domain : :ref:`Str` +* setattr : :ref:`Str` +* addattr : :ref:`Str` +* delattr : :ref:`Str` +* version : :ref:`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 \ No newline at end of file diff --git a/doc/api/realmdomains_show.md b/doc/api/realmdomains_show.md new file mode 100644 index 000000000..84bf38386 --- /dev/null +++ b/doc/api/realmdomains_show.md @@ -0,0 +1,29 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# realmdomains_show +Display the list of realm domains. + +### Arguments +No arguments. + +### Options +* rights : :ref:`Flag` **(Required)** + * Default: False +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* version : :ref:`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 \ No newline at end of file diff --git a/doc/api/role_add.md b/doc/api/role_add.md new file mode 100644 index 000000000..589eed062 --- /dev/null +++ b/doc/api/role_add.md @@ -0,0 +1,34 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# role_add +Add a new role. + +### Arguments +|Name|Type|Required +|-|-|- +|cn|:ref:`Str`|True + +### Options +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* no_members : :ref:`Flag` **(Required)** + * Default: False +* description : :ref:`Str` +* setattr : :ref:`Str` +* addattr : :ref:`Str` +* version : :ref:`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 \ No newline at end of file diff --git a/doc/api/role_add_member.md b/doc/api/role_add_member.md new file mode 100644 index 000000000..0993852de --- /dev/null +++ b/doc/api/role_add_member.md @@ -0,0 +1,37 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# role_add_member +Add members to a role. + +### Arguments +|Name|Type|Required +|-|-|- +|cn|:ref:`Str`|True + +### Options +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* no_members : :ref:`Flag` **(Required)** + * Default: False +* version : :ref:`Str` +* user : :ref:`Str` +* group : :ref:`Str` +* host : :ref:`Str` +* hostgroup : :ref:`Str` +* service : :ref:`Str` +* idoverrideuser : :ref:`Str` + +### Output +|Name|Type +|-|- +|completed|Output +|failed|Output +|result|Entry + +[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end) +### Semantics + +### Notes + +### Version differences \ No newline at end of file diff --git a/doc/api/role_add_privilege.md b/doc/api/role_add_privilege.md new file mode 100644 index 000000000..20ec3f2bf --- /dev/null +++ b/doc/api/role_add_privilege.md @@ -0,0 +1,32 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# role_add_privilege +Add privileges to a role. + +### Arguments +|Name|Type|Required +|-|-|- +|cn|:ref:`Str`|True + +### Options +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* no_members : :ref:`Flag` **(Required)** + * Default: False +* version : :ref:`Str` +* privilege : :ref:`Str` + +### Output +|Name|Type +|-|- +|completed|Output +|failed|Output +|result|Entry + +[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end) +### Semantics + +### Notes + +### Version differences \ No newline at end of file diff --git a/doc/api/role_del.md b/doc/api/role_del.md new file mode 100644 index 000000000..69f569389 --- /dev/null +++ b/doc/api/role_del.md @@ -0,0 +1,27 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# role_del +Delete a role. + +### Arguments +|Name|Type|Required +|-|-|- +|cn|:ref:`Str`|True + +### Options +* continue : :ref:`Flag` **(Required)** + * Default: False +* version : :ref:`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 \ No newline at end of file diff --git a/doc/api/role_find.md b/doc/api/role_find.md new file mode 100644 index 000000000..d7fb14f1e --- /dev/null +++ b/doc/api/role_find.md @@ -0,0 +1,38 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# role_find +Search for roles. + +### Arguments +|Name|Type|Required +|-|-|- +|criteria|:ref:`Str`|False + +### Options +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* no_members : :ref:`Flag` **(Required)** + * Default: True +* cn : :ref:`Str` +* description : :ref:`Str` +* timelimit : :ref:`Int` +* sizelimit : :ref:`Int` +* version : :ref:`Str` +* pkey_only : :ref:`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 \ No newline at end of file diff --git a/doc/api/role_mod.md b/doc/api/role_mod.md new file mode 100644 index 000000000..7a5644cbe --- /dev/null +++ b/doc/api/role_mod.md @@ -0,0 +1,38 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# role_mod +Modify a role. + +### Arguments +|Name|Type|Required +|-|-|- +|cn|:ref:`Str`|True + +### Options +* rights : :ref:`Flag` **(Required)** + * Default: False +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* no_members : :ref:`Flag` **(Required)** + * Default: False +* description : :ref:`Str` +* setattr : :ref:`Str` +* addattr : :ref:`Str` +* delattr : :ref:`Str` +* version : :ref:`Str` +* rename : :ref:`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 \ No newline at end of file diff --git a/doc/api/role_remove_member.md b/doc/api/role_remove_member.md new file mode 100644 index 000000000..9a9ae8f37 --- /dev/null +++ b/doc/api/role_remove_member.md @@ -0,0 +1,37 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# role_remove_member +Remove members from a role. + +### Arguments +|Name|Type|Required +|-|-|- +|cn|:ref:`Str`|True + +### Options +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* no_members : :ref:`Flag` **(Required)** + * Default: False +* version : :ref:`Str` +* user : :ref:`Str` +* group : :ref:`Str` +* host : :ref:`Str` +* hostgroup : :ref:`Str` +* service : :ref:`Str` +* idoverrideuser : :ref:`Str` + +### Output +|Name|Type +|-|- +|completed|Output +|failed|Output +|result|Entry + +[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end) +### Semantics + +### Notes + +### Version differences \ No newline at end of file diff --git a/doc/api/role_remove_privilege.md b/doc/api/role_remove_privilege.md new file mode 100644 index 000000000..e61a18ed0 --- /dev/null +++ b/doc/api/role_remove_privilege.md @@ -0,0 +1,32 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# role_remove_privilege +Remove privileges from a role. + +### Arguments +|Name|Type|Required +|-|-|- +|cn|:ref:`Str`|True + +### Options +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* no_members : :ref:`Flag` **(Required)** + * Default: False +* version : :ref:`Str` +* privilege : :ref:`Str` + +### Output +|Name|Type +|-|- +|completed|Output +|failed|Output +|result|Entry + +[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end) +### Semantics + +### Notes + +### Version differences \ No newline at end of file diff --git a/doc/api/role_show.md b/doc/api/role_show.md new file mode 100644 index 000000000..05ccb6e74 --- /dev/null +++ b/doc/api/role_show.md @@ -0,0 +1,33 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# role_show +Display information about a role. + +### Arguments +|Name|Type|Required +|-|-|- +|cn|:ref:`Str`|True + +### Options +* rights : :ref:`Flag` **(Required)** + * Default: False +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* no_members : :ref:`Flag` **(Required)** + * Default: False +* version : :ref:`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 \ No newline at end of file diff --git a/doc/api/schema.md b/doc/api/schema.md new file mode 100644 index 000000000..f4381b706 --- /dev/null +++ b/doc/api/schema.md @@ -0,0 +1,22 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# schema +Store and provide schema for commands and topics + +### Arguments +No arguments. + +### Options +* known_fingerprints : :ref:`Str` +* version : :ref:`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 \ No newline at end of file diff --git a/doc/api/selfservice_add.md b/doc/api/selfservice_add.md new file mode 100644 index 000000000..70615f069 --- /dev/null +++ b/doc/api/selfservice_add.md @@ -0,0 +1,31 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# selfservice_add +Add a new self-service permission. + +### Arguments +|Name|Type|Required +|-|-|- +|aciname|:ref:`Str`|True + +### Options +* attrs : :ref:`Str` **(Required)** +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* permissions : :ref:`Str` +* version : :ref:`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 \ No newline at end of file diff --git a/doc/api/selfservice_del.md b/doc/api/selfservice_del.md new file mode 100644 index 000000000..c3bf961ee --- /dev/null +++ b/doc/api/selfservice_del.md @@ -0,0 +1,25 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# selfservice_del +Delete a self-service permission. + +### Arguments +|Name|Type|Required +|-|-|- +|aciname|:ref:`Str`|True + +### Options +* version : :ref:`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 \ No newline at end of file diff --git a/doc/api/selfservice_find.md b/doc/api/selfservice_find.md new file mode 100644 index 000000000..77b029f3b --- /dev/null +++ b/doc/api/selfservice_find.md @@ -0,0 +1,35 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# selfservice_find +Search for a self-service permission. + +### Arguments +|Name|Type|Required +|-|-|- +|criteria|:ref:`Str`|False + +### Options +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* aciname : :ref:`Str` +* permissions : :ref:`Str` +* attrs : :ref:`Str` +* pkey_only : :ref:`Flag` + * Default: False +* version : :ref:`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 \ No newline at end of file diff --git a/doc/api/selfservice_mod.md b/doc/api/selfservice_mod.md new file mode 100644 index 000000000..756635015 --- /dev/null +++ b/doc/api/selfservice_mod.md @@ -0,0 +1,31 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# selfservice_mod +Modify a self-service permission. + +### Arguments +|Name|Type|Required +|-|-|- +|aciname|:ref:`Str`|True + +### Options +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* permissions : :ref:`Str` +* attrs : :ref:`Str` +* version : :ref:`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 \ No newline at end of file diff --git a/doc/api/selfservice_show.md b/doc/api/selfservice_show.md new file mode 100644 index 000000000..d01136019 --- /dev/null +++ b/doc/api/selfservice_show.md @@ -0,0 +1,29 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# selfservice_show +Display information about a self-service permission. + +### Arguments +|Name|Type|Required +|-|-|- +|aciname|:ref:`Str`|True + +### Options +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* version : :ref:`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 \ No newline at end of file diff --git a/doc/api/selinuxusermap_add.md b/doc/api/selinuxusermap_add.md new file mode 100644 index 000000000..741d77fb8 --- /dev/null +++ b/doc/api/selinuxusermap_add.md @@ -0,0 +1,41 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# selinuxusermap_add +Create a new SELinux User Map. + +### Arguments +|Name|Type|Required +|-|-|- +|cn|:ref:`Str`|True + +### Options +* ipaselinuxuser : :ref:`Str` **(Required)** +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* no_members : :ref:`Flag` **(Required)** + * Default: False +* seealso : :ref:`Str` +* usercategory : :ref:`StrEnum` + * Values: ('all',) +* hostcategory : :ref:`StrEnum` + * Values: ('all',) +* description : :ref:`Str` +* ipaenabledflag : :ref:`Bool` +* setattr : :ref:`Str` +* addattr : :ref:`Str` +* version : :ref:`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 \ No newline at end of file diff --git a/doc/api/selinuxusermap_add_host.md b/doc/api/selinuxusermap_add_host.md new file mode 100644 index 000000000..693f3a9bf --- /dev/null +++ b/doc/api/selinuxusermap_add_host.md @@ -0,0 +1,33 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# selinuxusermap_add_host +Add target hosts and hostgroups to an SELinux User Map rule. + +### Arguments +|Name|Type|Required +|-|-|- +|cn|:ref:`Str`|True + +### Options +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* no_members : :ref:`Flag` **(Required)** + * Default: False +* version : :ref:`Str` +* host : :ref:`Str` +* hostgroup : :ref:`Str` + +### Output +|Name|Type +|-|- +|completed|Output +|failed|Output +|result|Entry + +[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end) +### Semantics + +### Notes + +### Version differences \ No newline at end of file diff --git a/doc/api/selinuxusermap_add_user.md b/doc/api/selinuxusermap_add_user.md new file mode 100644 index 000000000..0f5f9be51 --- /dev/null +++ b/doc/api/selinuxusermap_add_user.md @@ -0,0 +1,33 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# selinuxusermap_add_user +Add users and groups to an SELinux User Map rule. + +### Arguments +|Name|Type|Required +|-|-|- +|cn|:ref:`Str`|True + +### Options +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* no_members : :ref:`Flag` **(Required)** + * Default: False +* version : :ref:`Str` +* user : :ref:`Str` +* group : :ref:`Str` + +### Output +|Name|Type +|-|- +|completed|Output +|failed|Output +|result|Entry + +[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end) +### Semantics + +### Notes + +### Version differences \ No newline at end of file diff --git a/doc/api/selinuxusermap_del.md b/doc/api/selinuxusermap_del.md new file mode 100644 index 000000000..f65525cd1 --- /dev/null +++ b/doc/api/selinuxusermap_del.md @@ -0,0 +1,27 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# selinuxusermap_del +Delete a SELinux User Map. + +### Arguments +|Name|Type|Required +|-|-|- +|cn|:ref:`Str`|True + +### Options +* continue : :ref:`Flag` **(Required)** + * Default: False +* version : :ref:`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 \ No newline at end of file diff --git a/doc/api/selinuxusermap_disable.md b/doc/api/selinuxusermap_disable.md new file mode 100644 index 000000000..83055abba --- /dev/null +++ b/doc/api/selinuxusermap_disable.md @@ -0,0 +1,25 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# selinuxusermap_disable +Disable an SELinux User Map rule. + +### Arguments +|Name|Type|Required +|-|-|- +|cn|:ref:`Str`|True + +### Options +* version : :ref:`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 \ No newline at end of file diff --git a/doc/api/selinuxusermap_enable.md b/doc/api/selinuxusermap_enable.md new file mode 100644 index 000000000..dba1c1629 --- /dev/null +++ b/doc/api/selinuxusermap_enable.md @@ -0,0 +1,25 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# selinuxusermap_enable +Enable an SELinux User Map rule. + +### Arguments +|Name|Type|Required +|-|-|- +|cn|:ref:`Str`|True + +### Options +* version : :ref:`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 \ No newline at end of file diff --git a/doc/api/selinuxusermap_find.md b/doc/api/selinuxusermap_find.md new file mode 100644 index 000000000..5f253b00b --- /dev/null +++ b/doc/api/selinuxusermap_find.md @@ -0,0 +1,45 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# selinuxusermap_find +Search for SELinux User Maps. + +### Arguments +|Name|Type|Required +|-|-|- +|criteria|:ref:`Str`|False + +### Options +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* no_members : :ref:`Flag` **(Required)** + * Default: True +* cn : :ref:`Str` +* ipaselinuxuser : :ref:`Str` +* seealso : :ref:`Str` +* usercategory : :ref:`StrEnum` + * Values: ('all',) +* hostcategory : :ref:`StrEnum` + * Values: ('all',) +* description : :ref:`Str` +* ipaenabledflag : :ref:`Bool` +* timelimit : :ref:`Int` +* sizelimit : :ref:`Int` +* version : :ref:`Str` +* pkey_only : :ref:`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 \ No newline at end of file diff --git a/doc/api/selinuxusermap_mod.md b/doc/api/selinuxusermap_mod.md new file mode 100644 index 000000000..fb55caec1 --- /dev/null +++ b/doc/api/selinuxusermap_mod.md @@ -0,0 +1,44 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# selinuxusermap_mod +Modify a SELinux User Map. + +### Arguments +|Name|Type|Required +|-|-|- +|cn|:ref:`Str`|True + +### Options +* rights : :ref:`Flag` **(Required)** + * Default: False +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* no_members : :ref:`Flag` **(Required)** + * Default: False +* ipaselinuxuser : :ref:`Str` +* seealso : :ref:`Str` +* usercategory : :ref:`StrEnum` + * Values: ('all',) +* hostcategory : :ref:`StrEnum` + * Values: ('all',) +* description : :ref:`Str` +* ipaenabledflag : :ref:`Bool` +* setattr : :ref:`Str` +* addattr : :ref:`Str` +* delattr : :ref:`Str` +* version : :ref:`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 \ No newline at end of file diff --git a/doc/api/selinuxusermap_remove_host.md b/doc/api/selinuxusermap_remove_host.md new file mode 100644 index 000000000..047878393 --- /dev/null +++ b/doc/api/selinuxusermap_remove_host.md @@ -0,0 +1,33 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# selinuxusermap_remove_host +Remove target hosts and hostgroups from an SELinux User Map rule. + +### Arguments +|Name|Type|Required +|-|-|- +|cn|:ref:`Str`|True + +### Options +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* no_members : :ref:`Flag` **(Required)** + * Default: False +* version : :ref:`Str` +* host : :ref:`Str` +* hostgroup : :ref:`Str` + +### Output +|Name|Type +|-|- +|completed|Output +|failed|Output +|result|Entry + +[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end) +### Semantics + +### Notes + +### Version differences \ No newline at end of file diff --git a/doc/api/selinuxusermap_remove_user.md b/doc/api/selinuxusermap_remove_user.md new file mode 100644 index 000000000..0aa783e2f --- /dev/null +++ b/doc/api/selinuxusermap_remove_user.md @@ -0,0 +1,33 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# selinuxusermap_remove_user +Remove users and groups from an SELinux User Map rule. + +### Arguments +|Name|Type|Required +|-|-|- +|cn|:ref:`Str`|True + +### Options +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* no_members : :ref:`Flag` **(Required)** + * Default: False +* version : :ref:`Str` +* user : :ref:`Str` +* group : :ref:`Str` + +### Output +|Name|Type +|-|- +|completed|Output +|failed|Output +|result|Entry + +[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end) +### Semantics + +### Notes + +### Version differences \ No newline at end of file diff --git a/doc/api/selinuxusermap_show.md b/doc/api/selinuxusermap_show.md new file mode 100644 index 000000000..3e27c6699 --- /dev/null +++ b/doc/api/selinuxusermap_show.md @@ -0,0 +1,33 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# selinuxusermap_show +Display the properties of a SELinux User Map rule. + +### Arguments +|Name|Type|Required +|-|-|- +|cn|:ref:`Str`|True + +### Options +* rights : :ref:`Flag` **(Required)** + * Default: False +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* no_members : :ref:`Flag` **(Required)** + * Default: False +* version : :ref:`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 \ No newline at end of file diff --git a/doc/api/server_conncheck.md b/doc/api/server_conncheck.md new file mode 100644 index 000000000..f85d47021 --- /dev/null +++ b/doc/api/server_conncheck.md @@ -0,0 +1,26 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# server_conncheck +Check connection to remote IPA server. + +### Arguments +|Name|Type|Required +|-|-|- +|cn|:ref:`Str`|True +|remote_cn|:ref:`Str`|True + +### Options +* version : :ref:`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 \ No newline at end of file diff --git a/doc/api/server_del.md b/doc/api/server_del.md new file mode 100644 index 000000000..cbb63cae3 --- /dev/null +++ b/doc/api/server_del.md @@ -0,0 +1,33 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# server_del +Delete IPA server. + +### Arguments +|Name|Type|Required +|-|-|- +|cn|:ref:`Str`|True + +### Options +* continue : :ref:`Flag` **(Required)** + * Default: False +* ignore_topology_disconnect : :ref:`Flag` + * Default: False +* ignore_last_of_role : :ref:`Flag` + * Default: False +* force : :ref:`Flag` + * Default: False +* version : :ref:`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 \ No newline at end of file diff --git a/doc/api/server_find.md b/doc/api/server_find.md new file mode 100644 index 000000000..3b63f88ea --- /dev/null +++ b/doc/api/server_find.md @@ -0,0 +1,44 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# server_find +Search for IPA servers. + +### Arguments +|Name|Type|Required +|-|-|- +|criteria|:ref:`Str`|False + +### Options +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* no_members : :ref:`Flag` **(Required)** + * Default: True +* cn : :ref:`Str` +* ipamindomainlevel : :ref:`Int` +* ipamaxdomainlevel : :ref:`Int` +* timelimit : :ref:`Int` +* sizelimit : :ref:`Int` +* version : :ref:`Str` +* pkey_only : :ref:`Flag` + * Default: False +* topologysuffix : :ref:`Str` +* no_topologysuffix : :ref:`Str` +* in_location : :ref:`DNSNameParam` +* not_in_location : :ref:`DNSNameParam` +* servrole : :ref:`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 \ No newline at end of file diff --git a/doc/api/server_mod.md b/doc/api/server_mod.md new file mode 100644 index 000000000..3b4b93c7c --- /dev/null +++ b/doc/api/server_mod.md @@ -0,0 +1,38 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# server_mod +Modify information about an IPA server. + +### Arguments +|Name|Type|Required +|-|-|- +|cn|:ref:`Str`|True + +### Options +* rights : :ref:`Flag` **(Required)** + * Default: False +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* no_members : :ref:`Flag` **(Required)** + * Default: False +* ipalocation_location : :ref:`DNSNameParam` +* ipaserviceweight : :ref:`Int` +* setattr : :ref:`Str` +* addattr : :ref:`Str` +* delattr : :ref:`Str` +* version : :ref:`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 \ No newline at end of file diff --git a/doc/api/server_role_find.md b/doc/api/server_role_find.md new file mode 100644 index 000000000..a0ecc759d --- /dev/null +++ b/doc/api/server_role_find.md @@ -0,0 +1,39 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# server_role_find +Find a server role on a server(s) + +### Arguments +|Name|Type|Required +|-|-|- +|criteria|:ref:`Str`|False + +### Options +* include_master : :ref:`Flag` **(Required)** + * Default: False +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* server_server : :ref:`Str` +* role_servrole : :ref:`Str` +* status : :ref:`StrEnum` + * Default: enabled + * Values: ('enabled', 'configured', 'hidden', 'absent') +* timelimit : :ref:`Int` +* sizelimit : :ref:`Int` +* version : :ref:`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 \ No newline at end of file diff --git a/doc/api/server_role_show.md b/doc/api/server_role_show.md new file mode 100644 index 000000000..af94b8f65 --- /dev/null +++ b/doc/api/server_role_show.md @@ -0,0 +1,30 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# server_role_show +Show role status on a server + +### Arguments +|Name|Type|Required +|-|-|- +|server_server|:ref:`Str`|True +|role_servrole|:ref:`Str`|True + +### Options +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* version : :ref:`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 \ No newline at end of file diff --git a/doc/api/server_show.md b/doc/api/server_show.md new file mode 100644 index 000000000..93e1ef426 --- /dev/null +++ b/doc/api/server_show.md @@ -0,0 +1,33 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# server_show +Show IPA server. + +### Arguments +|Name|Type|Required +|-|-|- +|cn|:ref:`Str`|True + +### Options +* rights : :ref:`Flag` **(Required)** + * Default: False +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* no_members : :ref:`Flag` **(Required)** + * Default: False +* version : :ref:`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 \ No newline at end of file diff --git a/doc/api/server_state.md b/doc/api/server_state.md new file mode 100644 index 000000000..32316aa73 --- /dev/null +++ b/doc/api/server_state.md @@ -0,0 +1,27 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# server_state +Set enabled/hidden state of a server. + +### Arguments +|Name|Type|Required +|-|-|- +|cn|:ref:`Str`|True + +### Options +* state : :ref:`StrEnum` **(Required)** + * Values: ('enabled', 'hidden') +* version : :ref:`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 \ No newline at end of file diff --git a/doc/api/service_add.md b/doc/api/service_add.md new file mode 100644 index 000000000..648424acb --- /dev/null +++ b/doc/api/service_add.md @@ -0,0 +1,45 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# service_add +Add a new IPA service. + +### Arguments +|Name|Type|Required +|-|-|- +|krbcanonicalname|:ref:`Principal`|True + +### Options +* force : :ref:`Flag` **(Required)** + * Default: False +* skip_host_check : :ref:`Flag` **(Required)** + * Default: False +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* no_members : :ref:`Flag` **(Required)** + * Default: False +* usercertificate : :ref:`Certificate` +* ipakrbauthzdata : :ref:`StrEnum` + * Values: ('MS-PAC', 'PAD', 'NONE') +* krbprincipalauthind : :ref:`StrEnum` + * Values: ('radius', 'otp', 'pkinit', 'hardened', 'idp') +* ipakrbrequirespreauth : :ref:`Bool` +* ipakrbokasdelegate : :ref:`Bool` +* ipakrboktoauthasdelegate : :ref:`Bool` +* setattr : :ref:`Str` +* addattr : :ref:`Str` +* version : :ref:`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 \ No newline at end of file diff --git a/doc/api/service_add_cert.md b/doc/api/service_add_cert.md new file mode 100644 index 000000000..b55681595 --- /dev/null +++ b/doc/api/service_add_cert.md @@ -0,0 +1,32 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# service_add_cert +Add new certificates to a service + +### Arguments +|Name|Type|Required +|-|-|- +|krbcanonicalname|:ref:`Principal`|True + +### Options +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* no_members : :ref:`Flag` **(Required)** + * Default: False +* usercertificate : :ref:`Certificate` **(Required)** +* version : :ref:`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 \ No newline at end of file diff --git a/doc/api/service_add_host.md b/doc/api/service_add_host.md new file mode 100644 index 000000000..8c6394f5e --- /dev/null +++ b/doc/api/service_add_host.md @@ -0,0 +1,32 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# service_add_host +Add hosts that can manage this service. + +### Arguments +|Name|Type|Required +|-|-|- +|krbcanonicalname|:ref:`Principal`|True + +### Options +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* no_members : :ref:`Flag` **(Required)** + * Default: False +* version : :ref:`Str` +* host : :ref:`Str` + +### Output +|Name|Type +|-|- +|completed|Output +|failed|Output +|result|Entry + +[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end) +### Semantics + +### Notes + +### Version differences \ No newline at end of file diff --git a/doc/api/service_add_principal.md b/doc/api/service_add_principal.md new file mode 100644 index 000000000..0e416a096 --- /dev/null +++ b/doc/api/service_add_principal.md @@ -0,0 +1,32 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# service_add_principal +Add new principal alias to a service + +### Arguments +|Name|Type|Required +|-|-|- +|krbcanonicalname|:ref:`Principal`|True +|krbprincipalname|:ref:`Principal`|True + +### Options +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* no_members : :ref:`Flag` **(Required)** + * Default: False +* version : :ref:`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 \ No newline at end of file diff --git a/doc/api/service_add_smb.md b/doc/api/service_add_smb.md new file mode 100644 index 000000000..f3e691aac --- /dev/null +++ b/doc/api/service_add_smb.md @@ -0,0 +1,37 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# service_add_smb +Add a new SMB service. + +### Arguments +|Name|Type|Required +|-|-|- +|fqdn|:ref:`Str`|True +|ipantflatname|:ref:`Str`|False + +### Options +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* no_members : :ref:`Flag` **(Required)** + * Default: False +* setattr : :ref:`Str` +* addattr : :ref:`Str` +* usercertificate : :ref:`Certificate` +* ipakrbokasdelegate : :ref:`Bool` +* ipakrboktoauthasdelegate : :ref:`Bool` +* version : :ref:`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 \ No newline at end of file diff --git a/doc/api/service_allow_create_keytab.md b/doc/api/service_allow_create_keytab.md new file mode 100644 index 000000000..979c5b1a4 --- /dev/null +++ b/doc/api/service_allow_create_keytab.md @@ -0,0 +1,35 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# service_allow_create_keytab +Allow users, groups, hosts or host groups to create a keytab of this service. + +### Arguments +|Name|Type|Required +|-|-|- +|krbcanonicalname|:ref:`Principal`|True + +### Options +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* no_members : :ref:`Flag` **(Required)** + * Default: False +* version : :ref:`Str` +* user : :ref:`Str` +* group : :ref:`Str` +* host : :ref:`Str` +* hostgroup : :ref:`Str` + +### Output +|Name|Type +|-|- +|completed|Output +|failed|Output +|result|Entry + +[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end) +### Semantics + +### Notes + +### Version differences \ No newline at end of file diff --git a/doc/api/service_allow_retrieve_keytab.md b/doc/api/service_allow_retrieve_keytab.md new file mode 100644 index 000000000..3ad7c5152 --- /dev/null +++ b/doc/api/service_allow_retrieve_keytab.md @@ -0,0 +1,35 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# service_allow_retrieve_keytab +Allow users, groups, hosts or host groups to retrieve a keytab of this service. + +### Arguments +|Name|Type|Required +|-|-|- +|krbcanonicalname|:ref:`Principal`|True + +### Options +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* no_members : :ref:`Flag` **(Required)** + * Default: False +* version : :ref:`Str` +* user : :ref:`Str` +* group : :ref:`Str` +* host : :ref:`Str` +* hostgroup : :ref:`Str` + +### Output +|Name|Type +|-|- +|completed|Output +|failed|Output +|result|Entry + +[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end) +### Semantics + +### Notes + +### Version differences \ No newline at end of file diff --git a/doc/api/service_del.md b/doc/api/service_del.md new file mode 100644 index 000000000..39ddc3bbe --- /dev/null +++ b/doc/api/service_del.md @@ -0,0 +1,27 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# service_del +Delete an IPA service. + +### Arguments +|Name|Type|Required +|-|-|- +|krbcanonicalname|:ref:`Principal`|True + +### Options +* continue : :ref:`Flag` **(Required)** + * Default: False +* version : :ref:`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 \ No newline at end of file diff --git a/doc/api/service_disable.md b/doc/api/service_disable.md new file mode 100644 index 000000000..7bfc9c17d --- /dev/null +++ b/doc/api/service_disable.md @@ -0,0 +1,25 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# service_disable +Disable the Kerberos key and SSL certificate of a service. + +### Arguments +|Name|Type|Required +|-|-|- +|krbcanonicalname|:ref:`Principal`|True + +### Options +* version : :ref:`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 \ No newline at end of file diff --git a/doc/api/service_disallow_create_keytab.md b/doc/api/service_disallow_create_keytab.md new file mode 100644 index 000000000..a74057a47 --- /dev/null +++ b/doc/api/service_disallow_create_keytab.md @@ -0,0 +1,35 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# service_disallow_create_keytab +Disallow users, groups, hosts or host groups to create a keytab of this service. + +### Arguments +|Name|Type|Required +|-|-|- +|krbcanonicalname|:ref:`Principal`|True + +### Options +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* no_members : :ref:`Flag` **(Required)** + * Default: False +* version : :ref:`Str` +* user : :ref:`Str` +* group : :ref:`Str` +* host : :ref:`Str` +* hostgroup : :ref:`Str` + +### Output +|Name|Type +|-|- +|completed|Output +|failed|Output +|result|Entry + +[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end) +### Semantics + +### Notes + +### Version differences \ No newline at end of file diff --git a/doc/api/service_disallow_retrieve_keytab.md b/doc/api/service_disallow_retrieve_keytab.md new file mode 100644 index 000000000..fe89740ee --- /dev/null +++ b/doc/api/service_disallow_retrieve_keytab.md @@ -0,0 +1,35 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# service_disallow_retrieve_keytab +Disallow users, groups, hosts or host groups to retrieve a keytab of this service. + +### Arguments +|Name|Type|Required +|-|-|- +|krbcanonicalname|:ref:`Principal`|True + +### Options +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* no_members : :ref:`Flag` **(Required)** + * Default: False +* version : :ref:`Str` +* user : :ref:`Str` +* group : :ref:`Str` +* host : :ref:`Str` +* hostgroup : :ref:`Str` + +### Output +|Name|Type +|-|- +|completed|Output +|failed|Output +|result|Entry + +[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end) +### Semantics + +### Notes + +### Version differences \ No newline at end of file diff --git a/doc/api/service_find.md b/doc/api/service_find.md new file mode 100644 index 000000000..770c20d30 --- /dev/null +++ b/doc/api/service_find.md @@ -0,0 +1,44 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# service_find +Search for IPA services. + +### Arguments +|Name|Type|Required +|-|-|- +|criteria|:ref:`Str`|False + +### Options +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* no_members : :ref:`Flag` **(Required)** + * Default: True +* krbcanonicalname : :ref:`Principal` +* krbprincipalname : :ref:`Principal` +* ipakrbauthzdata : :ref:`StrEnum` + * Values: ('MS-PAC', 'PAD', 'NONE') +* krbprincipalauthind : :ref:`StrEnum` + * Values: ('radius', 'otp', 'pkinit', 'hardened', 'idp') +* timelimit : :ref:`Int` +* sizelimit : :ref:`Int` +* version : :ref:`Str` +* pkey_only : :ref:`Flag` + * Default: False +* man_by_host : :ref:`Str` +* not_man_by_host : :ref:`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 \ No newline at end of file diff --git a/doc/api/service_mod.md b/doc/api/service_mod.md new file mode 100644 index 000000000..baa752050 --- /dev/null +++ b/doc/api/service_mod.md @@ -0,0 +1,45 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# service_mod +Modify an existing IPA service. + +### Arguments +|Name|Type|Required +|-|-|- +|krbcanonicalname|:ref:`Principal`|True + +### Options +* rights : :ref:`Flag` **(Required)** + * Default: False +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* no_members : :ref:`Flag` **(Required)** + * Default: False +* krbprincipalname : :ref:`Principal` +* usercertificate : :ref:`Certificate` +* ipakrbauthzdata : :ref:`StrEnum` + * Values: ('MS-PAC', 'PAD', 'NONE') +* krbprincipalauthind : :ref:`StrEnum` + * Values: ('radius', 'otp', 'pkinit', 'hardened', 'idp') +* ipakrbrequirespreauth : :ref:`Bool` +* ipakrbokasdelegate : :ref:`Bool` +* ipakrboktoauthasdelegate : :ref:`Bool` +* setattr : :ref:`Str` +* addattr : :ref:`Str` +* delattr : :ref:`Str` +* version : :ref:`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 \ No newline at end of file diff --git a/doc/api/service_remove_cert.md b/doc/api/service_remove_cert.md new file mode 100644 index 000000000..6cbd502db --- /dev/null +++ b/doc/api/service_remove_cert.md @@ -0,0 +1,32 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# service_remove_cert +Remove certificates from a service + +### Arguments +|Name|Type|Required +|-|-|- +|krbcanonicalname|:ref:`Principal`|True + +### Options +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* no_members : :ref:`Flag` **(Required)** + * Default: False +* usercertificate : :ref:`Certificate` **(Required)** +* version : :ref:`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 \ No newline at end of file diff --git a/doc/api/service_remove_host.md b/doc/api/service_remove_host.md new file mode 100644 index 000000000..c0f9b08d5 --- /dev/null +++ b/doc/api/service_remove_host.md @@ -0,0 +1,32 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# service_remove_host +Remove hosts that can manage this service. + +### Arguments +|Name|Type|Required +|-|-|- +|krbcanonicalname|:ref:`Principal`|True + +### Options +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* no_members : :ref:`Flag` **(Required)** + * Default: False +* version : :ref:`Str` +* host : :ref:`Str` + +### Output +|Name|Type +|-|- +|completed|Output +|failed|Output +|result|Entry + +[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end) +### Semantics + +### Notes + +### Version differences \ No newline at end of file diff --git a/doc/api/service_remove_principal.md b/doc/api/service_remove_principal.md new file mode 100644 index 000000000..5f717f67e --- /dev/null +++ b/doc/api/service_remove_principal.md @@ -0,0 +1,32 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# service_remove_principal +Remove principal alias from a service + +### Arguments +|Name|Type|Required +|-|-|- +|krbcanonicalname|:ref:`Principal`|True +|krbprincipalname|:ref:`Principal`|True + +### Options +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* no_members : :ref:`Flag` **(Required)** + * Default: False +* version : :ref:`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 \ No newline at end of file diff --git a/doc/api/service_show.md b/doc/api/service_show.md new file mode 100644 index 000000000..20394efa3 --- /dev/null +++ b/doc/api/service_show.md @@ -0,0 +1,34 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# service_show +Display information about an IPA service. + +### Arguments +|Name|Type|Required +|-|-|- +|krbcanonicalname|:ref:`Principal`|True + +### Options +* rights : :ref:`Flag` **(Required)** + * Default: False +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* no_members : :ref:`Flag` **(Required)** + * Default: False +* out : :ref:`Str` +* version : :ref:`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 \ No newline at end of file diff --git a/doc/api/servicedelegationrule_add.md b/doc/api/servicedelegationrule_add.md new file mode 100644 index 000000000..e5345aa66 --- /dev/null +++ b/doc/api/servicedelegationrule_add.md @@ -0,0 +1,33 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# servicedelegationrule_add +Create a new service delegation rule. + +### Arguments +|Name|Type|Required +|-|-|- +|cn|:ref:`Str`|True + +### Options +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* no_members : :ref:`Flag` **(Required)** + * Default: False +* setattr : :ref:`Str` +* addattr : :ref:`Str` +* version : :ref:`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 \ No newline at end of file diff --git a/doc/api/servicedelegationrule_add_member.md b/doc/api/servicedelegationrule_add_member.md new file mode 100644 index 000000000..7548e9e60 --- /dev/null +++ b/doc/api/servicedelegationrule_add_member.md @@ -0,0 +1,32 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# servicedelegationrule_add_member +Add member to a named service delegation rule. + +### Arguments +|Name|Type|Required +|-|-|- +|cn|:ref:`Str`|True + +### Options +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* no_members : :ref:`Flag` **(Required)** + * Default: False +* version : :ref:`Str` +* principal : :ref:`Str` + +### Output +|Name|Type +|-|- +|completed|Output +|failed|Output +|result|Entry + +[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end) +### Semantics + +### Notes + +### Version differences \ No newline at end of file diff --git a/doc/api/servicedelegationrule_add_target.md b/doc/api/servicedelegationrule_add_target.md new file mode 100644 index 000000000..36cd0a255 --- /dev/null +++ b/doc/api/servicedelegationrule_add_target.md @@ -0,0 +1,32 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# servicedelegationrule_add_target +Add target to a named service delegation rule. + +### Arguments +|Name|Type|Required +|-|-|- +|cn|:ref:`Str`|True + +### Options +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* no_members : :ref:`Flag` **(Required)** + * Default: False +* version : :ref:`Str` +* servicedelegationtarget : :ref:`Str` + +### Output +|Name|Type +|-|- +|completed|Output +|failed|Output +|result|Entry + +[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end) +### Semantics + +### Notes + +### Version differences \ No newline at end of file diff --git a/doc/api/servicedelegationrule_del.md b/doc/api/servicedelegationrule_del.md new file mode 100644 index 000000000..a21b39828 --- /dev/null +++ b/doc/api/servicedelegationrule_del.md @@ -0,0 +1,27 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# servicedelegationrule_del +Delete service delegation. + +### Arguments +|Name|Type|Required +|-|-|- +|cn|:ref:`Str`|True + +### Options +* continue : :ref:`Flag` **(Required)** + * Default: False +* version : :ref:`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 \ No newline at end of file diff --git a/doc/api/servicedelegationrule_find.md b/doc/api/servicedelegationrule_find.md new file mode 100644 index 000000000..c40115f93 --- /dev/null +++ b/doc/api/servicedelegationrule_find.md @@ -0,0 +1,37 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# servicedelegationrule_find +Search for service delegations rule. + +### Arguments +|Name|Type|Required +|-|-|- +|criteria|:ref:`Str`|False + +### Options +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* no_members : :ref:`Flag` **(Required)** + * Default: True +* cn : :ref:`Str` +* timelimit : :ref:`Int` +* sizelimit : :ref:`Int` +* version : :ref:`Str` +* pkey_only : :ref:`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 \ No newline at end of file diff --git a/doc/api/servicedelegationrule_remove_member.md b/doc/api/servicedelegationrule_remove_member.md new file mode 100644 index 000000000..e1e260574 --- /dev/null +++ b/doc/api/servicedelegationrule_remove_member.md @@ -0,0 +1,32 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# servicedelegationrule_remove_member +Remove member from a named service delegation rule. + +### Arguments +|Name|Type|Required +|-|-|- +|cn|:ref:`Str`|True + +### Options +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* no_members : :ref:`Flag` **(Required)** + * Default: False +* version : :ref:`Str` +* principal : :ref:`Str` + +### Output +|Name|Type +|-|- +|completed|Output +|failed|Output +|result|Entry + +[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end) +### Semantics + +### Notes + +### Version differences \ No newline at end of file diff --git a/doc/api/servicedelegationrule_remove_target.md b/doc/api/servicedelegationrule_remove_target.md new file mode 100644 index 000000000..489afd32b --- /dev/null +++ b/doc/api/servicedelegationrule_remove_target.md @@ -0,0 +1,32 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# servicedelegationrule_remove_target +Remove target from a named service delegation rule. + +### Arguments +|Name|Type|Required +|-|-|- +|cn|:ref:`Str`|True + +### Options +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* no_members : :ref:`Flag` **(Required)** + * Default: False +* version : :ref:`Str` +* servicedelegationtarget : :ref:`Str` + +### Output +|Name|Type +|-|- +|completed|Output +|failed|Output +|result|Entry + +[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end) +### Semantics + +### Notes + +### Version differences \ No newline at end of file diff --git a/doc/api/servicedelegationrule_show.md b/doc/api/servicedelegationrule_show.md new file mode 100644 index 000000000..8eb925193 --- /dev/null +++ b/doc/api/servicedelegationrule_show.md @@ -0,0 +1,33 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# servicedelegationrule_show +Display information about a named service delegation rule. + +### Arguments +|Name|Type|Required +|-|-|- +|cn|:ref:`Str`|True + +### Options +* rights : :ref:`Flag` **(Required)** + * Default: False +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* no_members : :ref:`Flag` **(Required)** + * Default: False +* version : :ref:`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 \ No newline at end of file diff --git a/doc/api/servicedelegationtarget_add.md b/doc/api/servicedelegationtarget_add.md new file mode 100644 index 000000000..f3fa41ed6 --- /dev/null +++ b/doc/api/servicedelegationtarget_add.md @@ -0,0 +1,31 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# servicedelegationtarget_add +Create a new service delegation target. + +### Arguments +|Name|Type|Required +|-|-|- +|cn|:ref:`Str`|True + +### Options +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* setattr : :ref:`Str` +* addattr : :ref:`Str` +* version : :ref:`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 \ No newline at end of file diff --git a/doc/api/servicedelegationtarget_add_member.md b/doc/api/servicedelegationtarget_add_member.md new file mode 100644 index 000000000..bcf903ec5 --- /dev/null +++ b/doc/api/servicedelegationtarget_add_member.md @@ -0,0 +1,30 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# servicedelegationtarget_add_member +Add member to a named service delegation target. + +### Arguments +|Name|Type|Required +|-|-|- +|cn|:ref:`Str`|True + +### Options +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* version : :ref:`Str` +* principal : :ref:`Str` + +### Output +|Name|Type +|-|- +|completed|Output +|failed|Output +|result|Entry + +[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end) +### Semantics + +### Notes + +### Version differences \ No newline at end of file diff --git a/doc/api/servicedelegationtarget_del.md b/doc/api/servicedelegationtarget_del.md new file mode 100644 index 000000000..b6f9d9d75 --- /dev/null +++ b/doc/api/servicedelegationtarget_del.md @@ -0,0 +1,27 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# servicedelegationtarget_del +Delete service delegation target. + +### Arguments +|Name|Type|Required +|-|-|- +|cn|:ref:`Str`|True + +### Options +* continue : :ref:`Flag` **(Required)** + * Default: False +* version : :ref:`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 \ No newline at end of file diff --git a/doc/api/servicedelegationtarget_find.md b/doc/api/servicedelegationtarget_find.md new file mode 100644 index 000000000..a2dbc6f63 --- /dev/null +++ b/doc/api/servicedelegationtarget_find.md @@ -0,0 +1,35 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# servicedelegationtarget_find +Search for service delegation target. + +### Arguments +|Name|Type|Required +|-|-|- +|criteria|:ref:`Str`|False + +### Options +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* cn : :ref:`Str` +* timelimit : :ref:`Int` +* sizelimit : :ref:`Int` +* version : :ref:`Str` +* pkey_only : :ref:`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 \ No newline at end of file diff --git a/doc/api/servicedelegationtarget_remove_member.md b/doc/api/servicedelegationtarget_remove_member.md new file mode 100644 index 000000000..6b2c91ddd --- /dev/null +++ b/doc/api/servicedelegationtarget_remove_member.md @@ -0,0 +1,30 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# servicedelegationtarget_remove_member +Remove member from a named service delegation target. + +### Arguments +|Name|Type|Required +|-|-|- +|cn|:ref:`Str`|True + +### Options +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* version : :ref:`Str` +* principal : :ref:`Str` + +### Output +|Name|Type +|-|- +|completed|Output +|failed|Output +|result|Entry + +[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end) +### Semantics + +### Notes + +### Version differences \ No newline at end of file diff --git a/doc/api/servicedelegationtarget_show.md b/doc/api/servicedelegationtarget_show.md new file mode 100644 index 000000000..97b385077 --- /dev/null +++ b/doc/api/servicedelegationtarget_show.md @@ -0,0 +1,31 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# servicedelegationtarget_show +Display information about a named service delegation target. + +### Arguments +|Name|Type|Required +|-|-|- +|cn|:ref:`Str`|True + +### Options +* rights : :ref:`Flag` **(Required)** + * Default: False +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* version : :ref:`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 \ No newline at end of file diff --git a/doc/api/session_logout.md b/doc/api/session_logout.md new file mode 100644 index 000000000..ce45bf9ce --- /dev/null +++ b/doc/api/session_logout.md @@ -0,0 +1,21 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# session_logout +RPC command used to log the current user out of their session. + +### Arguments +No arguments. + +### Options +* version : :ref:`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 \ No newline at end of file diff --git a/doc/api/sidgen_was_run.md b/doc/api/sidgen_was_run.md new file mode 100644 index 000000000..b3a1c621b --- /dev/null +++ b/doc/api/sidgen_was_run.md @@ -0,0 +1,21 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# sidgen_was_run +Determine whether ipa-adtrust-install has been run with sidgen task + +### Arguments +No arguments. + +### Options +* version : :ref:`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 \ No newline at end of file diff --git a/doc/api/stageuser_activate.md b/doc/api/stageuser_activate.md new file mode 100644 index 000000000..4f6b41634 --- /dev/null +++ b/doc/api/stageuser_activate.md @@ -0,0 +1,31 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# stageuser_activate +Activate a stage user. + +### Arguments +|Name|Type|Required +|-|-|- +|uid|:ref:`Str`|True + +### Options +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* no_members : :ref:`Flag` **(Required)** + * Default: False +* version : :ref:`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 \ No newline at end of file diff --git a/doc/api/stageuser_add.md b/doc/api/stageuser_add.md new file mode 100644 index 000000000..c94d59294 --- /dev/null +++ b/doc/api/stageuser_add.md @@ -0,0 +1,76 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# stageuser_add +Add a new stage user. + +### Arguments +|Name|Type|Required +|-|-|- +|uid|:ref:`Str`|True + +### Options +* givenname : :ref:`Str` **(Required)** +* sn : :ref:`Str` **(Required)** +* cn : :ref:`Str` **(Required)** +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* no_members : :ref:`Flag` **(Required)** + * Default: False +* displayname : :ref:`Str` +* initials : :ref:`Str` +* homedirectory : :ref:`Str` +* gecos : :ref:`Str` +* loginshell : :ref:`Str` +* krbprincipalname : :ref:`Principal` +* krbprincipalexpiration : :ref:`DateTime` +* krbpasswordexpiration : :ref:`DateTime` +* mail : :ref:`Str` +* userpassword : :ref:`Password` +* random : :ref:`Flag` + * Default: False +* uidnumber : :ref:`Int` +* gidnumber : :ref:`Int` +* street : :ref:`Str` +* l : :ref:`Str` +* st : :ref:`Str` +* postalcode : :ref:`Str` +* telephonenumber : :ref:`Str` +* mobile : :ref:`Str` +* pager : :ref:`Str` +* facsimiletelephonenumber : :ref:`Str` +* ou : :ref:`Str` +* title : :ref:`Str` +* manager : :ref:`Str` +* carlicense : :ref:`Str` +* ipasshpubkey : :ref:`Str` +* ipauserauthtype : :ref:`StrEnum` + * Values: ('password', 'radius', 'otp', 'pkinit', 'hardened', 'idp') +* userclass : :ref:`Str` +* ipatokenradiusconfiglink : :ref:`Str` +* ipatokenradiususername : :ref:`Str` +* ipaidpconfiglink : :ref:`Str` +* ipaidpsub : :ref:`Str` +* departmentnumber : :ref:`Str` +* employeenumber : :ref:`Str` +* employeetype : :ref:`Str` +* preferredlanguage : :ref:`Str` +* usercertificate : :ref:`Certificate` +* setattr : :ref:`Str` +* addattr : :ref:`Str` +* from_delete : :ref:`Bool` +* version : :ref:`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 \ No newline at end of file diff --git a/doc/api/stageuser_add_cert.md b/doc/api/stageuser_add_cert.md new file mode 100644 index 000000000..7ba146cbb --- /dev/null +++ b/doc/api/stageuser_add_cert.md @@ -0,0 +1,32 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# stageuser_add_cert +Add one or more certificates to the stageuser entry + +### Arguments +|Name|Type|Required +|-|-|- +|uid|:ref:`Str`|True + +### Options +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* no_members : :ref:`Flag` **(Required)** + * Default: False +* usercertificate : :ref:`Certificate` **(Required)** +* version : :ref:`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 \ No newline at end of file diff --git a/doc/api/stageuser_add_certmapdata.md b/doc/api/stageuser_add_certmapdata.md new file mode 100644 index 000000000..07ba4567a --- /dev/null +++ b/doc/api/stageuser_add_certmapdata.md @@ -0,0 +1,35 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# stageuser_add_certmapdata +Add one or more certificate mappings to the stage user entry. + +### Arguments +|Name|Type|Required +|-|-|- +|uid|:ref:`Str`|True +|ipacertmapdata|:ref:`Str`|False + +### Options +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* no_members : :ref:`Flag` **(Required)** + * Default: False +* issuer : :ref:`DNParam` +* subject : :ref:`DNParam` +* certificate : :ref:`Certificate` +* version : :ref:`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 \ No newline at end of file diff --git a/doc/api/stageuser_add_manager.md b/doc/api/stageuser_add_manager.md new file mode 100644 index 000000000..f9a1211f1 --- /dev/null +++ b/doc/api/stageuser_add_manager.md @@ -0,0 +1,32 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# stageuser_add_manager +Add a manager to the stage user entry + +### Arguments +|Name|Type|Required +|-|-|- +|uid|:ref:`Str`|True + +### Options +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* no_members : :ref:`Flag` **(Required)** + * Default: False +* version : :ref:`Str` +* user : :ref:`Str` + +### Output +|Name|Type +|-|- +|completed|Output +|failed|Output +|result|Entry + +[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end) +### Semantics + +### Notes + +### Version differences \ No newline at end of file diff --git a/doc/api/stageuser_add_principal.md b/doc/api/stageuser_add_principal.md new file mode 100644 index 000000000..efd830b62 --- /dev/null +++ b/doc/api/stageuser_add_principal.md @@ -0,0 +1,32 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# stageuser_add_principal +Add new principal alias to the stageuser entry + +### Arguments +|Name|Type|Required +|-|-|- +|uid|:ref:`Str`|True +|krbprincipalname|:ref:`Principal`|True + +### Options +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* no_members : :ref:`Flag` **(Required)** + * Default: False +* version : :ref:`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 \ No newline at end of file diff --git a/doc/api/stageuser_del.md b/doc/api/stageuser_del.md new file mode 100644 index 000000000..18c8ae929 --- /dev/null +++ b/doc/api/stageuser_del.md @@ -0,0 +1,27 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# stageuser_del +Delete a stage user. + +### Arguments +|Name|Type|Required +|-|-|- +|uid|:ref:`Str`|True + +### Options +* continue : :ref:`Flag` **(Required)** + * Default: False +* version : :ref:`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 \ No newline at end of file diff --git a/doc/api/stageuser_find.md b/doc/api/stageuser_find.md new file mode 100644 index 000000000..18b99edce --- /dev/null +++ b/doc/api/stageuser_find.md @@ -0,0 +1,93 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# stageuser_find +Search for stage users. + +### Arguments +|Name|Type|Required +|-|-|- +|criteria|:ref:`Str`|False + +### Options +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* no_members : :ref:`Flag` **(Required)** + * Default: True +* uid : :ref:`Str` +* givenname : :ref:`Str` +* sn : :ref:`Str` +* cn : :ref:`Str` +* displayname : :ref:`Str` +* initials : :ref:`Str` +* homedirectory : :ref:`Str` +* gecos : :ref:`Str` +* loginshell : :ref:`Str` +* krbprincipalname : :ref:`Principal` +* krbprincipalexpiration : :ref:`DateTime` +* krbpasswordexpiration : :ref:`DateTime` +* mail : :ref:`Str` +* userpassword : :ref:`Password` +* uidnumber : :ref:`Int` +* gidnumber : :ref:`Int` +* street : :ref:`Str` +* l : :ref:`Str` +* st : :ref:`Str` +* postalcode : :ref:`Str` +* telephonenumber : :ref:`Str` +* mobile : :ref:`Str` +* pager : :ref:`Str` +* facsimiletelephonenumber : :ref:`Str` +* ou : :ref:`Str` +* title : :ref:`Str` +* manager : :ref:`Str` +* carlicense : :ref:`Str` +* ipauserauthtype : :ref:`StrEnum` + * Values: ('password', 'radius', 'otp', 'pkinit', 'hardened', 'idp') +* userclass : :ref:`Str` +* ipatokenradiusconfiglink : :ref:`Str` +* ipatokenradiususername : :ref:`Str` +* ipaidpconfiglink : :ref:`Str` +* ipaidpsub : :ref:`Str` +* departmentnumber : :ref:`Str` +* employeenumber : :ref:`Str` +* employeetype : :ref:`Str` +* preferredlanguage : :ref:`Str` +* usercertificate : :ref:`Certificate` +* ipantlogonscript : :ref:`Str` +* ipantprofilepath : :ref:`Str` +* ipanthomedirectory : :ref:`Str` +* ipanthomedirectorydrive : :ref:`StrEnum` + * Values: ('A:', 'B:', 'C:', 'D:', 'E:', 'F:', 'G:', 'H:', 'I:', 'J:', 'K:', 'L:', 'M:', 'N:', 'O:', 'P:', 'Q:', 'R:', 'S:', 'T:', 'U:', 'V:', 'W:', 'X:', 'Y:', 'Z:') +* timelimit : :ref:`Int` +* sizelimit : :ref:`Int` +* version : :ref:`Str` +* pkey_only : :ref:`Flag` + * Default: False +* in_group : :ref:`Str` +* not_in_group : :ref:`Str` +* in_netgroup : :ref:`Str` +* not_in_netgroup : :ref:`Str` +* in_role : :ref:`Str` +* not_in_role : :ref:`Str` +* in_hbacrule : :ref:`Str` +* not_in_hbacrule : :ref:`Str` +* in_sudorule : :ref:`Str` +* not_in_sudorule : :ref:`Str` +* in_subid : :ref:`Str` +* not_in_subid : :ref:`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 \ No newline at end of file diff --git a/doc/api/stageuser_mod.md b/doc/api/stageuser_mod.md new file mode 100644 index 000000000..94d592da3 --- /dev/null +++ b/doc/api/stageuser_mod.md @@ -0,0 +1,84 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# stageuser_mod +Modify a stage user. + +### Arguments +|Name|Type|Required +|-|-|- +|uid|:ref:`Str`|True + +### Options +* rights : :ref:`Flag` **(Required)** + * Default: False +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* no_members : :ref:`Flag` **(Required)** + * Default: False +* givenname : :ref:`Str` +* sn : :ref:`Str` +* cn : :ref:`Str` +* displayname : :ref:`Str` +* initials : :ref:`Str` +* homedirectory : :ref:`Str` +* gecos : :ref:`Str` +* loginshell : :ref:`Str` +* krbprincipalname : :ref:`Principal` +* krbprincipalexpiration : :ref:`DateTime` +* krbpasswordexpiration : :ref:`DateTime` +* mail : :ref:`Str` +* userpassword : :ref:`Password` +* random : :ref:`Flag` + * Default: False +* uidnumber : :ref:`Int` +* gidnumber : :ref:`Int` +* street : :ref:`Str` +* l : :ref:`Str` +* st : :ref:`Str` +* postalcode : :ref:`Str` +* telephonenumber : :ref:`Str` +* mobile : :ref:`Str` +* pager : :ref:`Str` +* facsimiletelephonenumber : :ref:`Str` +* ou : :ref:`Str` +* title : :ref:`Str` +* manager : :ref:`Str` +* carlicense : :ref:`Str` +* ipasshpubkey : :ref:`Str` +* ipauserauthtype : :ref:`StrEnum` + * Values: ('password', 'radius', 'otp', 'pkinit', 'hardened', 'idp') +* userclass : :ref:`Str` +* ipatokenradiusconfiglink : :ref:`Str` +* ipatokenradiususername : :ref:`Str` +* ipaidpconfiglink : :ref:`Str` +* ipaidpsub : :ref:`Str` +* departmentnumber : :ref:`Str` +* employeenumber : :ref:`Str` +* employeetype : :ref:`Str` +* preferredlanguage : :ref:`Str` +* usercertificate : :ref:`Certificate` +* ipantlogonscript : :ref:`Str` +* ipantprofilepath : :ref:`Str` +* ipanthomedirectory : :ref:`Str` +* ipanthomedirectorydrive : :ref:`StrEnum` + * Values: ('A:', 'B:', 'C:', 'D:', 'E:', 'F:', 'G:', 'H:', 'I:', 'J:', 'K:', 'L:', 'M:', 'N:', 'O:', 'P:', 'Q:', 'R:', 'S:', 'T:', 'U:', 'V:', 'W:', 'X:', 'Y:', 'Z:') +* setattr : :ref:`Str` +* addattr : :ref:`Str` +* delattr : :ref:`Str` +* version : :ref:`Str` +* rename : :ref:`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 \ No newline at end of file diff --git a/doc/api/stageuser_remove_cert.md b/doc/api/stageuser_remove_cert.md new file mode 100644 index 000000000..8b6f20274 --- /dev/null +++ b/doc/api/stageuser_remove_cert.md @@ -0,0 +1,32 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# stageuser_remove_cert +Remove one or more certificates to the stageuser entry + +### Arguments +|Name|Type|Required +|-|-|- +|uid|:ref:`Str`|True + +### Options +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* no_members : :ref:`Flag` **(Required)** + * Default: False +* usercertificate : :ref:`Certificate` **(Required)** +* version : :ref:`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 \ No newline at end of file diff --git a/doc/api/stageuser_remove_certmapdata.md b/doc/api/stageuser_remove_certmapdata.md new file mode 100644 index 000000000..18545d8a0 --- /dev/null +++ b/doc/api/stageuser_remove_certmapdata.md @@ -0,0 +1,35 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# stageuser_remove_certmapdata +Remove one or more certificate mappings from the stage user entry. + +### Arguments +|Name|Type|Required +|-|-|- +|uid|:ref:`Str`|True +|ipacertmapdata|:ref:`Str`|False + +### Options +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* no_members : :ref:`Flag` **(Required)** + * Default: False +* issuer : :ref:`DNParam` +* subject : :ref:`DNParam` +* certificate : :ref:`Certificate` +* version : :ref:`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 \ No newline at end of file diff --git a/doc/api/stageuser_remove_manager.md b/doc/api/stageuser_remove_manager.md new file mode 100644 index 000000000..cd18b35b8 --- /dev/null +++ b/doc/api/stageuser_remove_manager.md @@ -0,0 +1,32 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# stageuser_remove_manager +Remove a manager to the stage user entry + +### Arguments +|Name|Type|Required +|-|-|- +|uid|:ref:`Str`|True + +### Options +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* no_members : :ref:`Flag` **(Required)** + * Default: False +* version : :ref:`Str` +* user : :ref:`Str` + +### Output +|Name|Type +|-|- +|completed|Output +|failed|Output +|result|Entry + +[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end) +### Semantics + +### Notes + +### Version differences \ No newline at end of file diff --git a/doc/api/stageuser_remove_principal.md b/doc/api/stageuser_remove_principal.md new file mode 100644 index 000000000..866b29f2b --- /dev/null +++ b/doc/api/stageuser_remove_principal.md @@ -0,0 +1,32 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# stageuser_remove_principal +Remove principal alias from the stageuser entry + +### Arguments +|Name|Type|Required +|-|-|- +|uid|:ref:`Str`|True +|krbprincipalname|:ref:`Principal`|True + +### Options +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* no_members : :ref:`Flag` **(Required)** + * Default: False +* version : :ref:`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 \ No newline at end of file diff --git a/doc/api/stageuser_show.md b/doc/api/stageuser_show.md new file mode 100644 index 000000000..6e85ad7a7 --- /dev/null +++ b/doc/api/stageuser_show.md @@ -0,0 +1,33 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# stageuser_show +Display information about a stage user. + +### Arguments +|Name|Type|Required +|-|-|- +|uid|:ref:`Str`|True + +### Options +* rights : :ref:`Flag` **(Required)** + * Default: False +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* no_members : :ref:`Flag` **(Required)** + * Default: False +* version : :ref:`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 \ No newline at end of file diff --git a/doc/api/subid_add.md b/doc/api/subid_add.md new file mode 100644 index 000000000..e828d0499 --- /dev/null +++ b/doc/api/subid_add.md @@ -0,0 +1,34 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# subid_add +Add a new subordinate id. + +### Arguments +|Name|Type|Required +|-|-|- +|ipauniqueid|:ref:`Str`|False + +### Options +* ipaowner : :ref:`Str` **(Required)** +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* description : :ref:`Str` +* ipasubuidnumber : :ref:`Int` +* setattr : :ref:`Str` +* addattr : :ref:`Str` +* version : :ref:`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 \ No newline at end of file diff --git a/doc/api/subid_del.md b/doc/api/subid_del.md new file mode 100644 index 000000000..4c2efd4e2 --- /dev/null +++ b/doc/api/subid_del.md @@ -0,0 +1,27 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# subid_del +Delete a subordinate id. + +### Arguments +|Name|Type|Required +|-|-|- +|ipauniqueid|:ref:`Str`|True + +### Options +* continue : :ref:`Flag` **(Required)** + * Default: False +* version : :ref:`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 \ No newline at end of file diff --git a/doc/api/subid_find.md b/doc/api/subid_find.md new file mode 100644 index 000000000..cca89a331 --- /dev/null +++ b/doc/api/subid_find.md @@ -0,0 +1,39 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# subid_find +Search for subordinate id. + +### Arguments +|Name|Type|Required +|-|-|- +|criteria|:ref:`Str`|False + +### Options +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* ipauniqueid : :ref:`Str` +* description : :ref:`Str` +* ipaowner : :ref:`Str` +* ipasubuidnumber : :ref:`Int` +* ipasubgidnumber : :ref:`Int` +* timelimit : :ref:`Int` +* sizelimit : :ref:`Int` +* version : :ref:`Str` +* pkey_only : :ref:`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 \ No newline at end of file diff --git a/doc/api/subid_generate.md b/doc/api/subid_generate.md new file mode 100644 index 000000000..822a91ef0 --- /dev/null +++ b/doc/api/subid_generate.md @@ -0,0 +1,28 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# subid_generate +Generate and auto-assign subuid and subgid range to user entry + +### Arguments +No arguments. + +### Options +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* ipaowner : :ref:`Str` +* version : :ref:`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 \ No newline at end of file diff --git a/doc/api/subid_match.md b/doc/api/subid_match.md new file mode 100644 index 000000000..b4059bf65 --- /dev/null +++ b/doc/api/subid_match.md @@ -0,0 +1,35 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# subid_match +Match users by any subordinate uid in their range + +### Arguments +|Name|Type|Required +|-|-|- +|criteria|:ref:`Str`|False + +### Options +* ipasubuidnumber : :ref:`Int` **(Required)** +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* timelimit : :ref:`Int` +* sizelimit : :ref:`Int` +* version : :ref:`Str` +* pkey_only : :ref:`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 \ No newline at end of file diff --git a/doc/api/subid_mod.md b/doc/api/subid_mod.md new file mode 100644 index 000000000..c14e7a6d1 --- /dev/null +++ b/doc/api/subid_mod.md @@ -0,0 +1,35 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# subid_mod +Modify a subordinate id. + +### Arguments +|Name|Type|Required +|-|-|- +|ipauniqueid|:ref:`Str`|True + +### Options +* rights : :ref:`Flag` **(Required)** + * Default: False +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* description : :ref:`Str` +* setattr : :ref:`Str` +* addattr : :ref:`Str` +* delattr : :ref:`Str` +* version : :ref:`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 \ No newline at end of file diff --git a/doc/api/subid_show.md b/doc/api/subid_show.md new file mode 100644 index 000000000..45b574b81 --- /dev/null +++ b/doc/api/subid_show.md @@ -0,0 +1,31 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# subid_show +Display information about a subordinate id. + +### Arguments +|Name|Type|Required +|-|-|- +|ipauniqueid|:ref:`Str`|True + +### Options +* rights : :ref:`Flag` **(Required)** + * Default: False +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* version : :ref:`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 \ No newline at end of file diff --git a/doc/api/subid_stats.md b/doc/api/subid_stats.md new file mode 100644 index 000000000..16692617c --- /dev/null +++ b/doc/api/subid_stats.md @@ -0,0 +1,26 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# subid_stats +Subordinate id statistics + +### Arguments +No arguments. + +### Options +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* version : :ref:`Str` + +### Output +|Name|Type +|-|- +|result|Entry +|summary|Output + +[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end) +### Semantics + +### Notes + +### Version differences \ No newline at end of file diff --git a/doc/api/sudocmd_add.md b/doc/api/sudocmd_add.md new file mode 100644 index 000000000..aeed4b0e7 --- /dev/null +++ b/doc/api/sudocmd_add.md @@ -0,0 +1,34 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# sudocmd_add +Create new Sudo Command. + +### Arguments +|Name|Type|Required +|-|-|- +|sudocmd|:ref:`Str`|True + +### Options +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* no_members : :ref:`Flag` **(Required)** + * Default: False +* description : :ref:`Str` +* setattr : :ref:`Str` +* addattr : :ref:`Str` +* version : :ref:`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 \ No newline at end of file diff --git a/doc/api/sudocmd_del.md b/doc/api/sudocmd_del.md new file mode 100644 index 000000000..a5bbd4ef2 --- /dev/null +++ b/doc/api/sudocmd_del.md @@ -0,0 +1,27 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# sudocmd_del +Delete Sudo Command. + +### Arguments +|Name|Type|Required +|-|-|- +|sudocmd|:ref:`Str`|True + +### Options +* continue : :ref:`Flag` **(Required)** + * Default: False +* version : :ref:`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 \ No newline at end of file diff --git a/doc/api/sudocmd_find.md b/doc/api/sudocmd_find.md new file mode 100644 index 000000000..0048aa840 --- /dev/null +++ b/doc/api/sudocmd_find.md @@ -0,0 +1,38 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# sudocmd_find +Search for Sudo Commands. + +### Arguments +|Name|Type|Required +|-|-|- +|criteria|:ref:`Str`|False + +### Options +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* no_members : :ref:`Flag` **(Required)** + * Default: True +* sudocmd : :ref:`Str` +* description : :ref:`Str` +* timelimit : :ref:`Int` +* sizelimit : :ref:`Int` +* version : :ref:`Str` +* pkey_only : :ref:`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 \ No newline at end of file diff --git a/doc/api/sudocmd_mod.md b/doc/api/sudocmd_mod.md new file mode 100644 index 000000000..d40a046bf --- /dev/null +++ b/doc/api/sudocmd_mod.md @@ -0,0 +1,37 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# sudocmd_mod +Modify Sudo Command. + +### Arguments +|Name|Type|Required +|-|-|- +|sudocmd|:ref:`Str`|True + +### Options +* rights : :ref:`Flag` **(Required)** + * Default: False +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* no_members : :ref:`Flag` **(Required)** + * Default: False +* description : :ref:`Str` +* setattr : :ref:`Str` +* addattr : :ref:`Str` +* delattr : :ref:`Str` +* version : :ref:`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 \ No newline at end of file diff --git a/doc/api/sudocmd_show.md b/doc/api/sudocmd_show.md new file mode 100644 index 000000000..f3bec7f05 --- /dev/null +++ b/doc/api/sudocmd_show.md @@ -0,0 +1,33 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# sudocmd_show +Display Sudo Command. + +### Arguments +|Name|Type|Required +|-|-|- +|sudocmd|:ref:`Str`|True + +### Options +* rights : :ref:`Flag` **(Required)** + * Default: False +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* no_members : :ref:`Flag` **(Required)** + * Default: False +* version : :ref:`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 \ No newline at end of file diff --git a/doc/api/sudocmdgroup_add.md b/doc/api/sudocmdgroup_add.md new file mode 100644 index 000000000..f1822344a --- /dev/null +++ b/doc/api/sudocmdgroup_add.md @@ -0,0 +1,34 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# sudocmdgroup_add +Create new Sudo Command Group. + +### Arguments +|Name|Type|Required +|-|-|- +|cn|:ref:`Str`|True + +### Options +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* no_members : :ref:`Flag` **(Required)** + * Default: False +* description : :ref:`Str` +* setattr : :ref:`Str` +* addattr : :ref:`Str` +* version : :ref:`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 \ No newline at end of file diff --git a/doc/api/sudocmdgroup_add_member.md b/doc/api/sudocmdgroup_add_member.md new file mode 100644 index 000000000..bc6ab5d5d --- /dev/null +++ b/doc/api/sudocmdgroup_add_member.md @@ -0,0 +1,32 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# sudocmdgroup_add_member +Add members to Sudo Command Group. + +### Arguments +|Name|Type|Required +|-|-|- +|cn|:ref:`Str`|True + +### Options +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* no_members : :ref:`Flag` **(Required)** + * Default: False +* version : :ref:`Str` +* sudocmd : :ref:`Str` + +### Output +|Name|Type +|-|- +|completed|Output +|failed|Output +|result|Entry + +[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end) +### Semantics + +### Notes + +### Version differences \ No newline at end of file diff --git a/doc/api/sudocmdgroup_del.md b/doc/api/sudocmdgroup_del.md new file mode 100644 index 000000000..4cd961bf8 --- /dev/null +++ b/doc/api/sudocmdgroup_del.md @@ -0,0 +1,27 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# sudocmdgroup_del +Delete Sudo Command Group. + +### Arguments +|Name|Type|Required +|-|-|- +|cn|:ref:`Str`|True + +### Options +* continue : :ref:`Flag` **(Required)** + * Default: False +* version : :ref:`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 \ No newline at end of file diff --git a/doc/api/sudocmdgroup_find.md b/doc/api/sudocmdgroup_find.md new file mode 100644 index 000000000..c5b71734f --- /dev/null +++ b/doc/api/sudocmdgroup_find.md @@ -0,0 +1,38 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# sudocmdgroup_find +Search for Sudo Command Groups. + +### Arguments +|Name|Type|Required +|-|-|- +|criteria|:ref:`Str`|False + +### Options +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* no_members : :ref:`Flag` **(Required)** + * Default: True +* cn : :ref:`Str` +* description : :ref:`Str` +* timelimit : :ref:`Int` +* sizelimit : :ref:`Int` +* version : :ref:`Str` +* pkey_only : :ref:`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 \ No newline at end of file diff --git a/doc/api/sudocmdgroup_mod.md b/doc/api/sudocmdgroup_mod.md new file mode 100644 index 000000000..56903236a --- /dev/null +++ b/doc/api/sudocmdgroup_mod.md @@ -0,0 +1,37 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# sudocmdgroup_mod +Modify Sudo Command Group. + +### Arguments +|Name|Type|Required +|-|-|- +|cn|:ref:`Str`|True + +### Options +* rights : :ref:`Flag` **(Required)** + * Default: False +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* no_members : :ref:`Flag` **(Required)** + * Default: False +* description : :ref:`Str` +* setattr : :ref:`Str` +* addattr : :ref:`Str` +* delattr : :ref:`Str` +* version : :ref:`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 \ No newline at end of file diff --git a/doc/api/sudocmdgroup_remove_member.md b/doc/api/sudocmdgroup_remove_member.md new file mode 100644 index 000000000..4db9ce9a3 --- /dev/null +++ b/doc/api/sudocmdgroup_remove_member.md @@ -0,0 +1,32 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# sudocmdgroup_remove_member +Remove members from Sudo Command Group. + +### Arguments +|Name|Type|Required +|-|-|- +|cn|:ref:`Str`|True + +### Options +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* no_members : :ref:`Flag` **(Required)** + * Default: False +* version : :ref:`Str` +* sudocmd : :ref:`Str` + +### Output +|Name|Type +|-|- +|completed|Output +|failed|Output +|result|Entry + +[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end) +### Semantics + +### Notes + +### Version differences \ No newline at end of file diff --git a/doc/api/sudocmdgroup_show.md b/doc/api/sudocmdgroup_show.md new file mode 100644 index 000000000..3f4f264f2 --- /dev/null +++ b/doc/api/sudocmdgroup_show.md @@ -0,0 +1,33 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# sudocmdgroup_show +Display Sudo Command Group. + +### Arguments +|Name|Type|Required +|-|-|- +|cn|:ref:`Str`|True + +### Options +* rights : :ref:`Flag` **(Required)** + * Default: False +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* no_members : :ref:`Flag` **(Required)** + * Default: False +* version : :ref:`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 \ No newline at end of file diff --git a/doc/api/sudorule_add.md b/doc/api/sudorule_add.md new file mode 100644 index 000000000..5f77f365a --- /dev/null +++ b/doc/api/sudorule_add.md @@ -0,0 +1,51 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# sudorule_add +Create new Sudo Rule. + +### Arguments +|Name|Type|Required +|-|-|- +|cn|:ref:`Str`|True + +### Options +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* no_members : :ref:`Flag` **(Required)** + * Default: False +* description : :ref:`Str` +* ipaenabledflag : :ref:`Bool` +* usercategory : :ref:`StrEnum` + * Values: ('all',) +* hostcategory : :ref:`StrEnum` + * Values: ('all',) +* cmdcategory : :ref:`StrEnum` + * Values: ('all',) +* ipasudorunasusercategory : :ref:`StrEnum` + * Values: ('all',) +* ipasudorunasgroupcategory : :ref:`StrEnum` + * Values: ('all',) +* sudoorder : :ref:`Int` + * Default: 0 +* externaluser : :ref:`Str` +* externalhost : :ref:`Str` +* ipasudorunasextuser : :ref:`Str` +* ipasudorunasextgroup : :ref:`Str` +* setattr : :ref:`Str` +* addattr : :ref:`Str` +* version : :ref:`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 \ No newline at end of file diff --git a/doc/api/sudorule_add_allow_command.md b/doc/api/sudorule_add_allow_command.md new file mode 100644 index 000000000..55a6b9ef8 --- /dev/null +++ b/doc/api/sudorule_add_allow_command.md @@ -0,0 +1,33 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# sudorule_add_allow_command +Add commands and sudo command groups affected by Sudo Rule. + +### Arguments +|Name|Type|Required +|-|-|- +|cn|:ref:`Str`|True + +### Options +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* no_members : :ref:`Flag` **(Required)** + * Default: False +* version : :ref:`Str` +* sudocmd : :ref:`Str` +* sudocmdgroup : :ref:`Str` + +### Output +|Name|Type +|-|- +|completed|Output +|failed|Output +|result|Entry + +[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end) +### Semantics + +### Notes + +### Version differences \ No newline at end of file diff --git a/doc/api/sudorule_add_deny_command.md b/doc/api/sudorule_add_deny_command.md new file mode 100644 index 000000000..b1508ff34 --- /dev/null +++ b/doc/api/sudorule_add_deny_command.md @@ -0,0 +1,33 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# sudorule_add_deny_command +Add commands and sudo command groups affected by Sudo Rule. + +### Arguments +|Name|Type|Required +|-|-|- +|cn|:ref:`Str`|True + +### Options +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* no_members : :ref:`Flag` **(Required)** + * Default: False +* version : :ref:`Str` +* sudocmd : :ref:`Str` +* sudocmdgroup : :ref:`Str` + +### Output +|Name|Type +|-|- +|completed|Output +|failed|Output +|result|Entry + +[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end) +### Semantics + +### Notes + +### Version differences \ No newline at end of file diff --git a/doc/api/sudorule_add_host.md b/doc/api/sudorule_add_host.md new file mode 100644 index 000000000..f37ada932 --- /dev/null +++ b/doc/api/sudorule_add_host.md @@ -0,0 +1,34 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# sudorule_add_host +Add hosts and hostgroups affected by Sudo Rule. + +### Arguments +|Name|Type|Required +|-|-|- +|cn|:ref:`Str`|True + +### Options +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* no_members : :ref:`Flag` **(Required)** + * Default: False +* version : :ref:`Str` +* host : :ref:`Str` +* hostgroup : :ref:`Str` +* hostmask : :ref:`Str` + +### Output +|Name|Type +|-|- +|completed|Output +|failed|Output +|result|Entry + +[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end) +### Semantics + +### Notes + +### Version differences \ No newline at end of file diff --git a/doc/api/sudorule_add_option.md b/doc/api/sudorule_add_option.md new file mode 100644 index 000000000..c325ae8cc --- /dev/null +++ b/doc/api/sudorule_add_option.md @@ -0,0 +1,32 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# sudorule_add_option +Add an option to the Sudo Rule. + +### Arguments +|Name|Type|Required +|-|-|- +|cn|:ref:`Str`|True + +### Options +* ipasudoopt : :ref:`Str` **(Required)** +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* no_members : :ref:`Flag` **(Required)** + * Default: False +* version : :ref:`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 \ No newline at end of file diff --git a/doc/api/sudorule_add_runasgroup.md b/doc/api/sudorule_add_runasgroup.md new file mode 100644 index 000000000..408a0b324 --- /dev/null +++ b/doc/api/sudorule_add_runasgroup.md @@ -0,0 +1,32 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# sudorule_add_runasgroup +Add group for Sudo to execute as. + +### Arguments +|Name|Type|Required +|-|-|- +|cn|:ref:`Str`|True + +### Options +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* no_members : :ref:`Flag` **(Required)** + * Default: False +* version : :ref:`Str` +* group : :ref:`Str` + +### Output +|Name|Type +|-|- +|completed|Output +|failed|Output +|result|Entry + +[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end) +### Semantics + +### Notes + +### Version differences \ No newline at end of file diff --git a/doc/api/sudorule_add_runasuser.md b/doc/api/sudorule_add_runasuser.md new file mode 100644 index 000000000..af8e3515f --- /dev/null +++ b/doc/api/sudorule_add_runasuser.md @@ -0,0 +1,33 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# sudorule_add_runasuser +Add users and groups for Sudo to execute as. + +### Arguments +|Name|Type|Required +|-|-|- +|cn|:ref:`Str`|True + +### Options +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* no_members : :ref:`Flag` **(Required)** + * Default: False +* version : :ref:`Str` +* user : :ref:`Str` +* group : :ref:`Str` + +### Output +|Name|Type +|-|- +|completed|Output +|failed|Output +|result|Entry + +[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end) +### Semantics + +### Notes + +### Version differences \ No newline at end of file diff --git a/doc/api/sudorule_add_user.md b/doc/api/sudorule_add_user.md new file mode 100644 index 000000000..1c13e0f0a --- /dev/null +++ b/doc/api/sudorule_add_user.md @@ -0,0 +1,33 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# sudorule_add_user +Add users and groups affected by Sudo Rule. + +### Arguments +|Name|Type|Required +|-|-|- +|cn|:ref:`Str`|True + +### Options +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* no_members : :ref:`Flag` **(Required)** + * Default: False +* version : :ref:`Str` +* user : :ref:`Str` +* group : :ref:`Str` + +### Output +|Name|Type +|-|- +|completed|Output +|failed|Output +|result|Entry + +[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end) +### Semantics + +### Notes + +### Version differences \ No newline at end of file diff --git a/doc/api/sudorule_del.md b/doc/api/sudorule_del.md new file mode 100644 index 000000000..c3be467de --- /dev/null +++ b/doc/api/sudorule_del.md @@ -0,0 +1,27 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# sudorule_del +Delete Sudo Rule. + +### Arguments +|Name|Type|Required +|-|-|- +|cn|:ref:`Str`|True + +### Options +* continue : :ref:`Flag` **(Required)** + * Default: False +* version : :ref:`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 \ No newline at end of file diff --git a/doc/api/sudorule_disable.md b/doc/api/sudorule_disable.md new file mode 100644 index 000000000..e04953dfc --- /dev/null +++ b/doc/api/sudorule_disable.md @@ -0,0 +1,23 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# sudorule_disable +Disable a Sudo Rule. + +### Arguments +|Name|Type|Required +|-|-|- +|cn|:ref:`Str`|True + +### Options +* version : :ref:`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 \ No newline at end of file diff --git a/doc/api/sudorule_enable.md b/doc/api/sudorule_enable.md new file mode 100644 index 000000000..2b5be1506 --- /dev/null +++ b/doc/api/sudorule_enable.md @@ -0,0 +1,23 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# sudorule_enable +Enable a Sudo Rule. + +### Arguments +|Name|Type|Required +|-|-|- +|cn|:ref:`Str`|True + +### Options +* version : :ref:`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 \ No newline at end of file diff --git a/doc/api/sudorule_find.md b/doc/api/sudorule_find.md new file mode 100644 index 000000000..1463774ec --- /dev/null +++ b/doc/api/sudorule_find.md @@ -0,0 +1,55 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# sudorule_find +Search for Sudo Rule. + +### Arguments +|Name|Type|Required +|-|-|- +|criteria|:ref:`Str`|False + +### Options +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* no_members : :ref:`Flag` **(Required)** + * Default: True +* cn : :ref:`Str` +* description : :ref:`Str` +* ipaenabledflag : :ref:`Bool` +* usercategory : :ref:`StrEnum` + * Values: ('all',) +* hostcategory : :ref:`StrEnum` + * Values: ('all',) +* cmdcategory : :ref:`StrEnum` + * Values: ('all',) +* ipasudorunasusercategory : :ref:`StrEnum` + * Values: ('all',) +* ipasudorunasgroupcategory : :ref:`StrEnum` + * Values: ('all',) +* sudoorder : :ref:`Int` + * Default: 0 +* externaluser : :ref:`Str` +* externalhost : :ref:`Str` +* ipasudorunasextuser : :ref:`Str` +* ipasudorunasextgroup : :ref:`Str` +* timelimit : :ref:`Int` +* sizelimit : :ref:`Int` +* version : :ref:`Str` +* pkey_only : :ref:`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 \ No newline at end of file diff --git a/doc/api/sudorule_mod.md b/doc/api/sudorule_mod.md new file mode 100644 index 000000000..52016a16b --- /dev/null +++ b/doc/api/sudorule_mod.md @@ -0,0 +1,55 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# sudorule_mod +Modify Sudo Rule. + +### Arguments +|Name|Type|Required +|-|-|- +|cn|:ref:`Str`|True + +### Options +* rights : :ref:`Flag` **(Required)** + * Default: False +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* no_members : :ref:`Flag` **(Required)** + * Default: False +* description : :ref:`Str` +* ipaenabledflag : :ref:`Bool` +* usercategory : :ref:`StrEnum` + * Values: ('all',) +* hostcategory : :ref:`StrEnum` + * Values: ('all',) +* cmdcategory : :ref:`StrEnum` + * Values: ('all',) +* ipasudorunasusercategory : :ref:`StrEnum` + * Values: ('all',) +* ipasudorunasgroupcategory : :ref:`StrEnum` + * Values: ('all',) +* sudoorder : :ref:`Int` + * Default: 0 +* externaluser : :ref:`Str` +* externalhost : :ref:`Str` +* ipasudorunasextuser : :ref:`Str` +* ipasudorunasextgroup : :ref:`Str` +* setattr : :ref:`Str` +* addattr : :ref:`Str` +* delattr : :ref:`Str` +* version : :ref:`Str` +* rename : :ref:`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 \ No newline at end of file diff --git a/doc/api/sudorule_remove_allow_command.md b/doc/api/sudorule_remove_allow_command.md new file mode 100644 index 000000000..d176d4e4d --- /dev/null +++ b/doc/api/sudorule_remove_allow_command.md @@ -0,0 +1,33 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# sudorule_remove_allow_command +Remove commands and sudo command groups affected by Sudo Rule. + +### Arguments +|Name|Type|Required +|-|-|- +|cn|:ref:`Str`|True + +### Options +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* no_members : :ref:`Flag` **(Required)** + * Default: False +* version : :ref:`Str` +* sudocmd : :ref:`Str` +* sudocmdgroup : :ref:`Str` + +### Output +|Name|Type +|-|- +|completed|Output +|failed|Output +|result|Entry + +[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end) +### Semantics + +### Notes + +### Version differences \ No newline at end of file diff --git a/doc/api/sudorule_remove_deny_command.md b/doc/api/sudorule_remove_deny_command.md new file mode 100644 index 000000000..bd6a396ed --- /dev/null +++ b/doc/api/sudorule_remove_deny_command.md @@ -0,0 +1,33 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# sudorule_remove_deny_command +Remove commands and sudo command groups affected by Sudo Rule. + +### Arguments +|Name|Type|Required +|-|-|- +|cn|:ref:`Str`|True + +### Options +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* no_members : :ref:`Flag` **(Required)** + * Default: False +* version : :ref:`Str` +* sudocmd : :ref:`Str` +* sudocmdgroup : :ref:`Str` + +### Output +|Name|Type +|-|- +|completed|Output +|failed|Output +|result|Entry + +[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end) +### Semantics + +### Notes + +### Version differences \ No newline at end of file diff --git a/doc/api/sudorule_remove_host.md b/doc/api/sudorule_remove_host.md new file mode 100644 index 000000000..05262c39f --- /dev/null +++ b/doc/api/sudorule_remove_host.md @@ -0,0 +1,34 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# sudorule_remove_host +Remove hosts and hostgroups affected by Sudo Rule. + +### Arguments +|Name|Type|Required +|-|-|- +|cn|:ref:`Str`|True + +### Options +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* no_members : :ref:`Flag` **(Required)** + * Default: False +* version : :ref:`Str` +* host : :ref:`Str` +* hostgroup : :ref:`Str` +* hostmask : :ref:`Str` + +### Output +|Name|Type +|-|- +|completed|Output +|failed|Output +|result|Entry + +[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end) +### Semantics + +### Notes + +### Version differences \ No newline at end of file diff --git a/doc/api/sudorule_remove_option.md b/doc/api/sudorule_remove_option.md new file mode 100644 index 000000000..67971166d --- /dev/null +++ b/doc/api/sudorule_remove_option.md @@ -0,0 +1,32 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# sudorule_remove_option +Remove an option from Sudo Rule. + +### Arguments +|Name|Type|Required +|-|-|- +|cn|:ref:`Str`|True + +### Options +* ipasudoopt : :ref:`Str` **(Required)** +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* no_members : :ref:`Flag` **(Required)** + * Default: False +* version : :ref:`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 \ No newline at end of file diff --git a/doc/api/sudorule_remove_runasgroup.md b/doc/api/sudorule_remove_runasgroup.md new file mode 100644 index 000000000..65e84cdf0 --- /dev/null +++ b/doc/api/sudorule_remove_runasgroup.md @@ -0,0 +1,32 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# sudorule_remove_runasgroup +Remove group for Sudo to execute as. + +### Arguments +|Name|Type|Required +|-|-|- +|cn|:ref:`Str`|True + +### Options +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* no_members : :ref:`Flag` **(Required)** + * Default: False +* version : :ref:`Str` +* group : :ref:`Str` + +### Output +|Name|Type +|-|- +|completed|Output +|failed|Output +|result|Entry + +[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end) +### Semantics + +### Notes + +### Version differences \ No newline at end of file diff --git a/doc/api/sudorule_remove_runasuser.md b/doc/api/sudorule_remove_runasuser.md new file mode 100644 index 000000000..3e969be03 --- /dev/null +++ b/doc/api/sudorule_remove_runasuser.md @@ -0,0 +1,33 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# sudorule_remove_runasuser +Remove users and groups for Sudo to execute as. + +### Arguments +|Name|Type|Required +|-|-|- +|cn|:ref:`Str`|True + +### Options +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* no_members : :ref:`Flag` **(Required)** + * Default: False +* version : :ref:`Str` +* user : :ref:`Str` +* group : :ref:`Str` + +### Output +|Name|Type +|-|- +|completed|Output +|failed|Output +|result|Entry + +[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end) +### Semantics + +### Notes + +### Version differences \ No newline at end of file diff --git a/doc/api/sudorule_remove_user.md b/doc/api/sudorule_remove_user.md new file mode 100644 index 000000000..40139fc0b --- /dev/null +++ b/doc/api/sudorule_remove_user.md @@ -0,0 +1,33 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# sudorule_remove_user +Remove users and groups affected by Sudo Rule. + +### Arguments +|Name|Type|Required +|-|-|- +|cn|:ref:`Str`|True + +### Options +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* no_members : :ref:`Flag` **(Required)** + * Default: False +* version : :ref:`Str` +* user : :ref:`Str` +* group : :ref:`Str` + +### Output +|Name|Type +|-|- +|completed|Output +|failed|Output +|result|Entry + +[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end) +### Semantics + +### Notes + +### Version differences \ No newline at end of file diff --git a/doc/api/sudorule_show.md b/doc/api/sudorule_show.md new file mode 100644 index 000000000..930d2305a --- /dev/null +++ b/doc/api/sudorule_show.md @@ -0,0 +1,33 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# sudorule_show +Display Sudo Rule. + +### Arguments +|Name|Type|Required +|-|-|- +|cn|:ref:`Str`|True + +### Options +* rights : :ref:`Flag` **(Required)** + * Default: False +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* no_members : :ref:`Flag` **(Required)** + * Default: False +* version : :ref:`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 \ No newline at end of file diff --git a/doc/api/topic_find.md b/doc/api/topic_find.md new file mode 100644 index 000000000..8c59b1113 --- /dev/null +++ b/doc/api/topic_find.md @@ -0,0 +1,32 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# topic_find +Search for help topics. + +### Arguments +|Name|Type|Required +|-|-|- +|criteria|:ref:`Str`|False + +### Options +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* version : :ref:`Str` +* pkey_only : :ref:`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 \ No newline at end of file diff --git a/doc/api/topic_show.md b/doc/api/topic_show.md new file mode 100644 index 000000000..10102bb9b --- /dev/null +++ b/doc/api/topic_show.md @@ -0,0 +1,29 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# topic_show +Display information about a help topic. + +### Arguments +|Name|Type|Required +|-|-|- +|full_name|:ref:`Str`|True + +### Options +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* version : :ref:`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 \ No newline at end of file diff --git a/doc/api/topologysegment_add.md b/doc/api/topologysegment_add.md new file mode 100644 index 000000000..c1fcd38d7 --- /dev/null +++ b/doc/api/topologysegment_add.md @@ -0,0 +1,43 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# topologysegment_add +Add a new segment. + +### Arguments +|Name|Type|Required +|-|-|- +|topologysuffixcn|:ref:`Str`|True +|cn|:ref:`Str`|True + +### Options +* iparepltoposegmentleftnode : :ref:`Str` **(Required)** +* iparepltoposegmentrightnode : :ref:`Str` **(Required)** +* iparepltoposegmentdirection : :ref:`StrEnum` **(Required)** + * Default: both + * Values: ('both', 'left-right', 'right-left') +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* nsds5replicastripattrs : :ref:`Str` +* nsds5replicatedattributelist : :ref:`Str` +* nsds5replicatedattributelisttotal : :ref:`Str` +* nsds5replicatimeout : :ref:`Int` +* nsds5replicaenabled : :ref:`StrEnum` + * Values: ('on', 'off') +* setattr : :ref:`Str` +* addattr : :ref:`Str` +* version : :ref:`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 \ No newline at end of file diff --git a/doc/api/topologysegment_del.md b/doc/api/topologysegment_del.md new file mode 100644 index 000000000..4e196b83e --- /dev/null +++ b/doc/api/topologysegment_del.md @@ -0,0 +1,28 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# topologysegment_del +Delete a segment. + +### Arguments +|Name|Type|Required +|-|-|- +|topologysuffixcn|:ref:`Str`|True +|cn|:ref:`Str`|True + +### Options +* continue : :ref:`Flag` **(Required)** + * Default: False +* version : :ref:`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 \ No newline at end of file diff --git a/doc/api/topologysegment_find.md b/doc/api/topologysegment_find.md new file mode 100644 index 000000000..a88b64aa4 --- /dev/null +++ b/doc/api/topologysegment_find.md @@ -0,0 +1,47 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# topologysegment_find +Search for topology segments. + +### Arguments +|Name|Type|Required +|-|-|- +|topologysuffixcn|:ref:`Str`|True +|criteria|:ref:`Str`|False + +### Options +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* cn : :ref:`Str` +* iparepltoposegmentleftnode : :ref:`Str` +* iparepltoposegmentrightnode : :ref:`Str` +* iparepltoposegmentdirection : :ref:`StrEnum` + * Default: both + * Values: ('both', 'left-right', 'right-left') +* nsds5replicastripattrs : :ref:`Str` +* nsds5replicatedattributelist : :ref:`Str` +* nsds5replicatedattributelisttotal : :ref:`Str` +* nsds5replicatimeout : :ref:`Int` +* nsds5replicaenabled : :ref:`StrEnum` + * Values: ('on', 'off') +* timelimit : :ref:`Int` +* sizelimit : :ref:`Int` +* version : :ref:`Str` +* pkey_only : :ref:`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 \ No newline at end of file diff --git a/doc/api/topologysegment_mod.md b/doc/api/topologysegment_mod.md new file mode 100644 index 000000000..ae36539b4 --- /dev/null +++ b/doc/api/topologysegment_mod.md @@ -0,0 +1,41 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# topologysegment_mod +Modify a segment. + +### Arguments +|Name|Type|Required +|-|-|- +|topologysuffixcn|:ref:`Str`|True +|cn|:ref:`Str`|True + +### Options +* rights : :ref:`Flag` **(Required)** + * Default: False +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* nsds5replicastripattrs : :ref:`Str` +* nsds5replicatedattributelist : :ref:`Str` +* nsds5replicatedattributelisttotal : :ref:`Str` +* nsds5replicatimeout : :ref:`Int` +* nsds5replicaenabled : :ref:`StrEnum` + * Values: ('on', 'off') +* setattr : :ref:`Str` +* addattr : :ref:`Str` +* delattr : :ref:`Str` +* version : :ref:`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 \ No newline at end of file diff --git a/doc/api/topologysegment_reinitialize.md b/doc/api/topologysegment_reinitialize.md new file mode 100644 index 000000000..bde882c3c --- /dev/null +++ b/doc/api/topologysegment_reinitialize.md @@ -0,0 +1,32 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# topologysegment_reinitialize +Request a full re-initialization of the node retrieving data from the other node. + +### Arguments +|Name|Type|Required +|-|-|- +|topologysuffixcn|:ref:`Str`|True +|cn|:ref:`Str`|True + +### Options +* left : :ref:`Flag` + * Default: False +* right : :ref:`Flag` + * Default: False +* stop : :ref:`Flag` + * Default: False +* version : :ref:`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 \ No newline at end of file diff --git a/doc/api/topologysegment_show.md b/doc/api/topologysegment_show.md new file mode 100644 index 000000000..090e493a0 --- /dev/null +++ b/doc/api/topologysegment_show.md @@ -0,0 +1,32 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# topologysegment_show +Display a segment. + +### Arguments +|Name|Type|Required +|-|-|- +|topologysuffixcn|:ref:`Str`|True +|cn|:ref:`Str`|True + +### Options +* rights : :ref:`Flag` **(Required)** + * Default: False +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* version : :ref:`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 \ No newline at end of file diff --git a/doc/api/topologysuffix_add.md b/doc/api/topologysuffix_add.md new file mode 100644 index 000000000..2954f96dd --- /dev/null +++ b/doc/api/topologysuffix_add.md @@ -0,0 +1,32 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# topologysuffix_add +Add a new topology suffix to be managed. + +### Arguments +|Name|Type|Required +|-|-|- +|cn|:ref:`Str`|True + +### Options +* iparepltopoconfroot : :ref:`DNParam` **(Required)** +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* setattr : :ref:`Str` +* addattr : :ref:`Str` +* version : :ref:`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 \ No newline at end of file diff --git a/doc/api/topologysuffix_del.md b/doc/api/topologysuffix_del.md new file mode 100644 index 000000000..5061a6287 --- /dev/null +++ b/doc/api/topologysuffix_del.md @@ -0,0 +1,27 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# topologysuffix_del +Delete a topology suffix. + +### Arguments +|Name|Type|Required +|-|-|- +|cn|:ref:`Str`|True + +### Options +* continue : :ref:`Flag` **(Required)** + * Default: False +* version : :ref:`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 \ No newline at end of file diff --git a/doc/api/topologysuffix_find.md b/doc/api/topologysuffix_find.md new file mode 100644 index 000000000..9e78fed15 --- /dev/null +++ b/doc/api/topologysuffix_find.md @@ -0,0 +1,36 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# topologysuffix_find +Search for topology suffixes. + +### Arguments +|Name|Type|Required +|-|-|- +|criteria|:ref:`Str`|False + +### Options +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* cn : :ref:`Str` +* iparepltopoconfroot : :ref:`DNParam` +* timelimit : :ref:`Int` +* sizelimit : :ref:`Int` +* version : :ref:`Str` +* pkey_only : :ref:`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 \ No newline at end of file diff --git a/doc/api/topologysuffix_mod.md b/doc/api/topologysuffix_mod.md new file mode 100644 index 000000000..9bff3d557 --- /dev/null +++ b/doc/api/topologysuffix_mod.md @@ -0,0 +1,35 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# topologysuffix_mod +Modify a topology suffix. + +### Arguments +|Name|Type|Required +|-|-|- +|cn|:ref:`Str`|True + +### Options +* rights : :ref:`Flag` **(Required)** + * Default: False +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* iparepltopoconfroot : :ref:`DNParam` +* setattr : :ref:`Str` +* addattr : :ref:`Str` +* delattr : :ref:`Str` +* version : :ref:`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 \ No newline at end of file diff --git a/doc/api/topologysuffix_show.md b/doc/api/topologysuffix_show.md new file mode 100644 index 000000000..9291a990b --- /dev/null +++ b/doc/api/topologysuffix_show.md @@ -0,0 +1,31 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# topologysuffix_show +Show managed suffix. + +### Arguments +|Name|Type|Required +|-|-|- +|cn|:ref:`Str`|True + +### Options +* rights : :ref:`Flag` **(Required)** + * Default: False +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* version : :ref:`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 \ No newline at end of file diff --git a/doc/api/topologysuffix_verify.md b/doc/api/topologysuffix_verify.md new file mode 100644 index 000000000..c8a69dee2 --- /dev/null +++ b/doc/api/topologysuffix_verify.md @@ -0,0 +1,30 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# topologysuffix_verify + +Verify replication topology for suffix. + +Checks done: +1. check if a topology is not disconnected. In other words if there are +replication paths between all servers. +2. check if servers don't have more than the recommended number of +replication agreements + +### Arguments +|Name|Type|Required +|-|-|- +|cn|:ref:`Str`|True + +### Options +* version : :ref:`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 \ No newline at end of file diff --git a/doc/api/trust_add.md b/doc/api/trust_add.md new file mode 100644 index 000000000..81bd06c74 --- /dev/null +++ b/doc/api/trust_add.md @@ -0,0 +1,63 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# trust_add + +Add new trust to use. + +This command establishes trust relationship to another domain +which becomes 'trusted'. As result, users of the trusted domain +may access resources of this domain. + +Only trusts to Active Directory domains are supported right now. + +The command can be safely run multiple times against the same domain, +this will cause change to trust relationship credentials on both +sides. + +Note that if the command was previously run with a specific range type, +or with automatic detection of the range type, and you want to configure a +different range type, you may need to delete first the ID range using +ipa idrange-del before retrying the command with the desired range type. + + +### Arguments +|Name|Type|Required +|-|-|- +|cn|:ref:`Str`|True + +### Options +* trust_type : :ref:`StrEnum` **(Required)** + * Default: ad + * Values: ('ad',) +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* setattr : :ref:`Str` +* addattr : :ref:`Str` +* realm_admin : :ref:`Str` +* realm_passwd : :ref:`Password` +* realm_server : :ref:`Str` +* trust_secret : :ref:`Password` +* base_id : :ref:`Int` +* range_size : :ref:`Int` +* range_type : :ref:`StrEnum` + * Values: ('ipa-ad-trust', 'ipa-ad-trust-posix') +* bidirectional : :ref:`Bool` + * Default: False +* external : :ref:`Bool` + * Default: False +* version : :ref:`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 \ No newline at end of file diff --git a/doc/api/trust_del.md b/doc/api/trust_del.md new file mode 100644 index 000000000..2fd48dc5d --- /dev/null +++ b/doc/api/trust_del.md @@ -0,0 +1,27 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# trust_del +Delete a trust. + +### Arguments +|Name|Type|Required +|-|-|- +|cn|:ref:`Str`|True + +### Options +* continue : :ref:`Flag` **(Required)** + * Default: False +* version : :ref:`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 \ No newline at end of file diff --git a/doc/api/trust_enable_agent.md b/doc/api/trust_enable_agent.md new file mode 100644 index 000000000..a480534be --- /dev/null +++ b/doc/api/trust_enable_agent.md @@ -0,0 +1,27 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# trust_enable_agent +Configure this server as a trust agent. + +### Arguments +|Name|Type|Required +|-|-|- +|remote_cn|:ref:`Str`|True + +### Options +* enable_compat : :ref:`Flag` **(Required)** + * Default: False +* version : :ref:`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 \ No newline at end of file diff --git a/doc/api/trust_fetch_domains.md b/doc/api/trust_fetch_domains.md new file mode 100644 index 000000000..9389d53e7 --- /dev/null +++ b/doc/api/trust_fetch_domains.md @@ -0,0 +1,35 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# trust_fetch_domains +Refresh list of the domains associated with the trust + +### Arguments +|Name|Type|Required +|-|-|- +|cn|:ref:`Str`|True + +### Options +* rights : :ref:`Flag` **(Required)** + * Default: False +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* realm_admin : :ref:`Str` +* realm_passwd : :ref:`Password` +* realm_server : :ref:`Str` +* version : :ref:`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 \ No newline at end of file diff --git a/doc/api/trust_find.md b/doc/api/trust_find.md new file mode 100644 index 000000000..d485969c7 --- /dev/null +++ b/doc/api/trust_find.md @@ -0,0 +1,39 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# trust_find +Search for trusts. + +### Arguments +|Name|Type|Required +|-|-|- +|criteria|:ref:`Str`|False + +### Options +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* cn : :ref:`Str` +* ipantflatname : :ref:`Str` +* ipanttrusteddomainsid : :ref:`Str` +* ipantsidblacklistincoming : :ref:`Str` +* ipantsidblacklistoutgoing : :ref:`Str` +* timelimit : :ref:`Int` +* sizelimit : :ref:`Int` +* version : :ref:`Str` +* pkey_only : :ref:`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 \ No newline at end of file diff --git a/doc/api/trust_mod.md b/doc/api/trust_mod.md new file mode 100644 index 000000000..64ddb240f --- /dev/null +++ b/doc/api/trust_mod.md @@ -0,0 +1,42 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# trust_mod + +Modify a trust (for future use). + +Currently only the default option to modify the LDAP attributes is +available. More specific options will be added in coming releases. + + +### Arguments +|Name|Type|Required +|-|-|- +|cn|:ref:`Str`|True + +### Options +* rights : :ref:`Flag` **(Required)** + * Default: False +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* ipantsidblacklistincoming : :ref:`Str` +* ipantsidblacklistoutgoing : :ref:`Str` +* ipantadditionalsuffixes : :ref:`Str` +* setattr : :ref:`Str` +* addattr : :ref:`Str` +* delattr : :ref:`Str` +* version : :ref:`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 \ No newline at end of file diff --git a/doc/api/trust_resolve.md b/doc/api/trust_resolve.md new file mode 100644 index 000000000..f7523c1b2 --- /dev/null +++ b/doc/api/trust_resolve.md @@ -0,0 +1,26 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# trust_resolve +Resolve security identifiers of users and groups in trusted domains + +### Arguments +No arguments. + +### Options +* sids : :ref:`Str` **(Required)** +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* version : :ref:`Str` + +### Output +|Name|Type +|-|- +|result|ListOfEntries + +[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end) +### Semantics + +### Notes + +### Version differences \ No newline at end of file diff --git a/doc/api/trust_show.md b/doc/api/trust_show.md new file mode 100644 index 000000000..4a01a74e0 --- /dev/null +++ b/doc/api/trust_show.md @@ -0,0 +1,31 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# trust_show +Display information about a trust. + +### Arguments +|Name|Type|Required +|-|-|- +|cn|:ref:`Str`|True + +### Options +* rights : :ref:`Flag` **(Required)** + * Default: False +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* version : :ref:`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 \ No newline at end of file diff --git a/doc/api/trustconfig_mod.md b/doc/api/trustconfig_mod.md new file mode 100644 index 000000000..7442eaf60 --- /dev/null +++ b/doc/api/trustconfig_mod.md @@ -0,0 +1,36 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# trustconfig_mod +Modify global trust configuration. + +### Arguments +No arguments. + +### Options +* rights : :ref:`Flag` **(Required)** + * Default: False +* trust_type : :ref:`StrEnum` **(Required)** + * Default: ad + * Values: ('ad',) +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* ipantfallbackprimarygroup : :ref:`Str` +* setattr : :ref:`Str` +* addattr : :ref:`Str` +* delattr : :ref:`Str` +* version : :ref:`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 \ No newline at end of file diff --git a/doc/api/trustconfig_show.md b/doc/api/trustconfig_show.md new file mode 100644 index 000000000..5271c4f8e --- /dev/null +++ b/doc/api/trustconfig_show.md @@ -0,0 +1,32 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# trustconfig_show +Show global trust configuration. + +### Arguments +No arguments. + +### Options +* rights : :ref:`Flag` **(Required)** + * Default: False +* trust_type : :ref:`StrEnum` **(Required)** + * Default: ad + * Values: ('ad',) +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* version : :ref:`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 \ No newline at end of file diff --git a/doc/api/trustdomain_add.md b/doc/api/trustdomain_add.md new file mode 100644 index 000000000..124bc60c6 --- /dev/null +++ b/doc/api/trustdomain_add.md @@ -0,0 +1,37 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# trustdomain_add +Allow access from the trusted domain + +### Arguments +|Name|Type|Required +|-|-|- +|trustcn|:ref:`Str`|True +|cn|:ref:`Str`|True + +### Options +* trust_type : :ref:`StrEnum` **(Required)** + * Default: ad + * Values: ('ad',) +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* ipantflatname : :ref:`Str` +* ipanttrusteddomainsid : :ref:`Str` +* setattr : :ref:`Str` +* addattr : :ref:`Str` +* version : :ref:`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 \ No newline at end of file diff --git a/doc/api/trustdomain_del.md b/doc/api/trustdomain_del.md new file mode 100644 index 000000000..1256eaaaa --- /dev/null +++ b/doc/api/trustdomain_del.md @@ -0,0 +1,28 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# trustdomain_del +Remove information about the domain associated with the trust. + +### Arguments +|Name|Type|Required +|-|-|- +|trustcn|:ref:`Str`|True +|cn|:ref:`Str`|True + +### Options +* continue : :ref:`Flag` **(Required)** + * Default: False +* version : :ref:`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 \ No newline at end of file diff --git a/doc/api/trustdomain_disable.md b/doc/api/trustdomain_disable.md new file mode 100644 index 000000000..452f48dda --- /dev/null +++ b/doc/api/trustdomain_disable.md @@ -0,0 +1,26 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# trustdomain_disable +Disable use of IPA resources by the domain of the trust + +### Arguments +|Name|Type|Required +|-|-|- +|trustcn|:ref:`Str`|True +|cn|:ref:`Str`|True + +### Options +* version : :ref:`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 \ No newline at end of file diff --git a/doc/api/trustdomain_enable.md b/doc/api/trustdomain_enable.md new file mode 100644 index 000000000..c3bb92f82 --- /dev/null +++ b/doc/api/trustdomain_enable.md @@ -0,0 +1,26 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# trustdomain_enable +Allow use of IPA resources by the domain of the trust + +### Arguments +|Name|Type|Required +|-|-|- +|trustcn|:ref:`Str`|True +|cn|:ref:`Str`|True + +### Options +* version : :ref:`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 \ No newline at end of file diff --git a/doc/api/trustdomain_find.md b/doc/api/trustdomain_find.md new file mode 100644 index 000000000..e59b4ae7e --- /dev/null +++ b/doc/api/trustdomain_find.md @@ -0,0 +1,38 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# trustdomain_find +Search domains of the trust + +### Arguments +|Name|Type|Required +|-|-|- +|trustcn|:ref:`Str`|True +|criteria|:ref:`Str`|False + +### Options +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* cn : :ref:`Str` +* ipantflatname : :ref:`Str` +* ipanttrusteddomainsid : :ref:`Str` +* timelimit : :ref:`Int` +* sizelimit : :ref:`Int` +* version : :ref:`Str` +* pkey_only : :ref:`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 \ No newline at end of file diff --git a/doc/api/trustdomain_mod.md b/doc/api/trustdomain_mod.md new file mode 100644 index 000000000..55e2855c8 --- /dev/null +++ b/doc/api/trustdomain_mod.md @@ -0,0 +1,40 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# trustdomain_mod +Modify trustdomain of the trust + +### Arguments +|Name|Type|Required +|-|-|- +|trustcn|:ref:`Str`|True +|cn|:ref:`Str`|True + +### Options +* rights : :ref:`Flag` **(Required)** + * Default: False +* trust_type : :ref:`StrEnum` **(Required)** + * Default: ad + * Values: ('ad',) +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* ipantflatname : :ref:`Str` +* ipanttrusteddomainsid : :ref:`Str` +* setattr : :ref:`Str` +* addattr : :ref:`Str` +* delattr : :ref:`Str` +* version : :ref:`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 \ No newline at end of file diff --git a/doc/api/user_add.md b/doc/api/user_add.md new file mode 100644 index 000000000..2dd1c68e5 --- /dev/null +++ b/doc/api/user_add.md @@ -0,0 +1,79 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# user_add +Add a new user. + +### Arguments +|Name|Type|Required +|-|-|- +|uid|:ref:`Str`|True + +### Options +* givenname : :ref:`Str` **(Required)** +* sn : :ref:`Str` **(Required)** +* cn : :ref:`Str` **(Required)** +* noprivate : :ref:`Flag` **(Required)** + * Default: False +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* no_members : :ref:`Flag` **(Required)** + * Default: False +* displayname : :ref:`Str` +* initials : :ref:`Str` +* homedirectory : :ref:`Str` +* gecos : :ref:`Str` +* loginshell : :ref:`Str` +* krbprincipalname : :ref:`Principal` +* krbprincipalexpiration : :ref:`DateTime` +* krbpasswordexpiration : :ref:`DateTime` +* mail : :ref:`Str` +* userpassword : :ref:`Password` +* random : :ref:`Flag` + * Default: False +* uidnumber : :ref:`Int` +* gidnumber : :ref:`Int` +* street : :ref:`Str` +* l : :ref:`Str` +* st : :ref:`Str` +* postalcode : :ref:`Str` +* telephonenumber : :ref:`Str` +* mobile : :ref:`Str` +* pager : :ref:`Str` +* facsimiletelephonenumber : :ref:`Str` +* ou : :ref:`Str` +* title : :ref:`Str` +* manager : :ref:`Str` +* carlicense : :ref:`Str` +* ipasshpubkey : :ref:`Str` +* ipauserauthtype : :ref:`StrEnum` + * Values: ('password', 'radius', 'otp', 'pkinit', 'hardened', 'idp') +* userclass : :ref:`Str` +* ipatokenradiusconfiglink : :ref:`Str` +* ipatokenradiususername : :ref:`Str` +* ipaidpconfiglink : :ref:`Str` +* ipaidpsub : :ref:`Str` +* departmentnumber : :ref:`Str` +* employeenumber : :ref:`Str` +* employeetype : :ref:`Str` +* preferredlanguage : :ref:`Str` +* usercertificate : :ref:`Certificate` +* nsaccountlock : :ref:`Bool` + * Default: False +* setattr : :ref:`Str` +* addattr : :ref:`Str` +* version : :ref:`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 \ No newline at end of file diff --git a/doc/api/user_add_cert.md b/doc/api/user_add_cert.md new file mode 100644 index 000000000..6a5db6260 --- /dev/null +++ b/doc/api/user_add_cert.md @@ -0,0 +1,32 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# user_add_cert +Add one or more certificates to the user entry + +### Arguments +|Name|Type|Required +|-|-|- +|uid|:ref:`Str`|True + +### Options +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* no_members : :ref:`Flag` **(Required)** + * Default: False +* usercertificate : :ref:`Certificate` **(Required)** +* version : :ref:`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 \ No newline at end of file diff --git a/doc/api/user_add_certmapdata.md b/doc/api/user_add_certmapdata.md new file mode 100644 index 000000000..37f593b3a --- /dev/null +++ b/doc/api/user_add_certmapdata.md @@ -0,0 +1,35 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# user_add_certmapdata +Add one or more certificate mappings to the user entry. + +### Arguments +|Name|Type|Required +|-|-|- +|uid|:ref:`Str`|True +|ipacertmapdata|:ref:`Str`|False + +### Options +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* no_members : :ref:`Flag` **(Required)** + * Default: False +* issuer : :ref:`DNParam` +* subject : :ref:`DNParam` +* certificate : :ref:`Certificate` +* version : :ref:`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 \ No newline at end of file diff --git a/doc/api/user_add_manager.md b/doc/api/user_add_manager.md new file mode 100644 index 000000000..bd9811025 --- /dev/null +++ b/doc/api/user_add_manager.md @@ -0,0 +1,32 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# user_add_manager +Add a manager to the user entry + +### Arguments +|Name|Type|Required +|-|-|- +|uid|:ref:`Str`|True + +### Options +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* no_members : :ref:`Flag` **(Required)** + * Default: False +* version : :ref:`Str` +* user : :ref:`Str` + +### Output +|Name|Type +|-|- +|completed|Output +|failed|Output +|result|Entry + +[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end) +### Semantics + +### Notes + +### Version differences \ No newline at end of file diff --git a/doc/api/user_add_principal.md b/doc/api/user_add_principal.md new file mode 100644 index 000000000..469368da4 --- /dev/null +++ b/doc/api/user_add_principal.md @@ -0,0 +1,32 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# user_add_principal +Add new principal alias to the user entry + +### Arguments +|Name|Type|Required +|-|-|- +|uid|:ref:`Str`|True +|krbprincipalname|:ref:`Principal`|True + +### Options +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* no_members : :ref:`Flag` **(Required)** + * Default: False +* version : :ref:`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 \ No newline at end of file diff --git a/doc/api/user_del.md b/doc/api/user_del.md new file mode 100644 index 000000000..97d5f1820 --- /dev/null +++ b/doc/api/user_del.md @@ -0,0 +1,28 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# user_del +Delete a user. + +### Arguments +|Name|Type|Required +|-|-|- +|uid|:ref:`Str`|True + +### Options +* continue : :ref:`Flag` **(Required)** + * Default: False +* preserve : :ref:`Bool` +* version : :ref:`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 \ No newline at end of file diff --git a/doc/api/user_disable.md b/doc/api/user_disable.md new file mode 100644 index 000000000..5b6009dcf --- /dev/null +++ b/doc/api/user_disable.md @@ -0,0 +1,25 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# user_disable +Disable a user account. + +### Arguments +|Name|Type|Required +|-|-|- +|uid|:ref:`Str`|True + +### Options +* version : :ref:`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 \ No newline at end of file diff --git a/doc/api/user_enable.md b/doc/api/user_enable.md new file mode 100644 index 000000000..5310b4e0c --- /dev/null +++ b/doc/api/user_enable.md @@ -0,0 +1,25 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# user_enable +Enable a user account. + +### Arguments +|Name|Type|Required +|-|-|- +|uid|:ref:`Str`|True + +### Options +* version : :ref:`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 \ No newline at end of file diff --git a/doc/api/user_find.md b/doc/api/user_find.md new file mode 100644 index 000000000..a63d040b1 --- /dev/null +++ b/doc/api/user_find.md @@ -0,0 +1,99 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# user_find +Search for users. + +### Arguments +|Name|Type|Required +|-|-|- +|criteria|:ref:`Str`|False + +### Options +* whoami : :ref:`Flag` **(Required)** + * Default: False +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* no_members : :ref:`Flag` **(Required)** + * Default: True +* uid : :ref:`Str` +* givenname : :ref:`Str` +* sn : :ref:`Str` +* cn : :ref:`Str` +* displayname : :ref:`Str` +* initials : :ref:`Str` +* homedirectory : :ref:`Str` +* gecos : :ref:`Str` +* loginshell : :ref:`Str` +* krbprincipalname : :ref:`Principal` +* krbprincipalexpiration : :ref:`DateTime` +* krbpasswordexpiration : :ref:`DateTime` +* mail : :ref:`Str` +* userpassword : :ref:`Password` +* uidnumber : :ref:`Int` +* gidnumber : :ref:`Int` +* street : :ref:`Str` +* l : :ref:`Str` +* st : :ref:`Str` +* postalcode : :ref:`Str` +* telephonenumber : :ref:`Str` +* mobile : :ref:`Str` +* pager : :ref:`Str` +* facsimiletelephonenumber : :ref:`Str` +* ou : :ref:`Str` +* title : :ref:`Str` +* manager : :ref:`Str` +* carlicense : :ref:`Str` +* ipauserauthtype : :ref:`StrEnum` + * Values: ('password', 'radius', 'otp', 'pkinit', 'hardened', 'idp') +* userclass : :ref:`Str` +* ipatokenradiusconfiglink : :ref:`Str` +* ipatokenradiususername : :ref:`Str` +* ipaidpconfiglink : :ref:`Str` +* ipaidpsub : :ref:`Str` +* departmentnumber : :ref:`Str` +* employeenumber : :ref:`Str` +* employeetype : :ref:`Str` +* preferredlanguage : :ref:`Str` +* usercertificate : :ref:`Certificate` +* ipantlogonscript : :ref:`Str` +* ipantprofilepath : :ref:`Str` +* ipanthomedirectory : :ref:`Str` +* ipanthomedirectorydrive : :ref:`StrEnum` + * Values: ('A:', 'B:', 'C:', 'D:', 'E:', 'F:', 'G:', 'H:', 'I:', 'J:', 'K:', 'L:', 'M:', 'N:', 'O:', 'P:', 'Q:', 'R:', 'S:', 'T:', 'U:', 'V:', 'W:', 'X:', 'Y:', 'Z:') +* nsaccountlock : :ref:`Bool` + * Default: False +* preserved : :ref:`Bool` + * Default: False +* timelimit : :ref:`Int` +* sizelimit : :ref:`Int` +* version : :ref:`Str` +* pkey_only : :ref:`Flag` + * Default: False +* in_group : :ref:`Str` +* not_in_group : :ref:`Str` +* in_netgroup : :ref:`Str` +* not_in_netgroup : :ref:`Str` +* in_role : :ref:`Str` +* not_in_role : :ref:`Str` +* in_hbacrule : :ref:`Str` +* not_in_hbacrule : :ref:`Str` +* in_sudorule : :ref:`Str` +* not_in_sudorule : :ref:`Str` +* in_subid : :ref:`Str` +* not_in_subid : :ref:`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 \ No newline at end of file diff --git a/doc/api/user_mod.md b/doc/api/user_mod.md new file mode 100644 index 000000000..3096320e0 --- /dev/null +++ b/doc/api/user_mod.md @@ -0,0 +1,86 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# user_mod +Modify a user. + +### Arguments +|Name|Type|Required +|-|-|- +|uid|:ref:`Str`|True + +### Options +* rights : :ref:`Flag` **(Required)** + * Default: False +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* no_members : :ref:`Flag` **(Required)** + * Default: False +* givenname : :ref:`Str` +* sn : :ref:`Str` +* cn : :ref:`Str` +* displayname : :ref:`Str` +* initials : :ref:`Str` +* homedirectory : :ref:`Str` +* gecos : :ref:`Str` +* loginshell : :ref:`Str` +* krbprincipalname : :ref:`Principal` +* krbprincipalexpiration : :ref:`DateTime` +* krbpasswordexpiration : :ref:`DateTime` +* mail : :ref:`Str` +* userpassword : :ref:`Password` +* random : :ref:`Flag` + * Default: False +* uidnumber : :ref:`Int` +* gidnumber : :ref:`Int` +* street : :ref:`Str` +* l : :ref:`Str` +* st : :ref:`Str` +* postalcode : :ref:`Str` +* telephonenumber : :ref:`Str` +* mobile : :ref:`Str` +* pager : :ref:`Str` +* facsimiletelephonenumber : :ref:`Str` +* ou : :ref:`Str` +* title : :ref:`Str` +* manager : :ref:`Str` +* carlicense : :ref:`Str` +* ipasshpubkey : :ref:`Str` +* ipauserauthtype : :ref:`StrEnum` + * Values: ('password', 'radius', 'otp', 'pkinit', 'hardened', 'idp') +* userclass : :ref:`Str` +* ipatokenradiusconfiglink : :ref:`Str` +* ipatokenradiususername : :ref:`Str` +* ipaidpconfiglink : :ref:`Str` +* ipaidpsub : :ref:`Str` +* departmentnumber : :ref:`Str` +* employeenumber : :ref:`Str` +* employeetype : :ref:`Str` +* preferredlanguage : :ref:`Str` +* usercertificate : :ref:`Certificate` +* ipantlogonscript : :ref:`Str` +* ipantprofilepath : :ref:`Str` +* ipanthomedirectory : :ref:`Str` +* ipanthomedirectorydrive : :ref:`StrEnum` + * Values: ('A:', 'B:', 'C:', 'D:', 'E:', 'F:', 'G:', 'H:', 'I:', 'J:', 'K:', 'L:', 'M:', 'N:', 'O:', 'P:', 'Q:', 'R:', 'S:', 'T:', 'U:', 'V:', 'W:', 'X:', 'Y:', 'Z:') +* nsaccountlock : :ref:`Bool` + * Default: False +* setattr : :ref:`Str` +* addattr : :ref:`Str` +* delattr : :ref:`Str` +* version : :ref:`Str` +* rename : :ref:`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 \ No newline at end of file diff --git a/doc/api/user_remove_cert.md b/doc/api/user_remove_cert.md new file mode 100644 index 000000000..1264f177a --- /dev/null +++ b/doc/api/user_remove_cert.md @@ -0,0 +1,32 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# user_remove_cert +Remove one or more certificates to the user entry + +### Arguments +|Name|Type|Required +|-|-|- +|uid|:ref:`Str`|True + +### Options +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* no_members : :ref:`Flag` **(Required)** + * Default: False +* usercertificate : :ref:`Certificate` **(Required)** +* version : :ref:`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 \ No newline at end of file diff --git a/doc/api/user_remove_certmapdata.md b/doc/api/user_remove_certmapdata.md new file mode 100644 index 000000000..ac4044122 --- /dev/null +++ b/doc/api/user_remove_certmapdata.md @@ -0,0 +1,35 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# user_remove_certmapdata +Remove one or more certificate mappings from the user entry. + +### Arguments +|Name|Type|Required +|-|-|- +|uid|:ref:`Str`|True +|ipacertmapdata|:ref:`Str`|False + +### Options +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* no_members : :ref:`Flag` **(Required)** + * Default: False +* issuer : :ref:`DNParam` +* subject : :ref:`DNParam` +* certificate : :ref:`Certificate` +* version : :ref:`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 \ No newline at end of file diff --git a/doc/api/user_remove_manager.md b/doc/api/user_remove_manager.md new file mode 100644 index 000000000..191325c4e --- /dev/null +++ b/doc/api/user_remove_manager.md @@ -0,0 +1,32 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# user_remove_manager +Remove a manager to the user entry + +### Arguments +|Name|Type|Required +|-|-|- +|uid|:ref:`Str`|True + +### Options +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* no_members : :ref:`Flag` **(Required)** + * Default: False +* version : :ref:`Str` +* user : :ref:`Str` + +### Output +|Name|Type +|-|- +|completed|Output +|failed|Output +|result|Entry + +[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end) +### Semantics + +### Notes + +### Version differences \ No newline at end of file diff --git a/doc/api/user_remove_principal.md b/doc/api/user_remove_principal.md new file mode 100644 index 000000000..8ca4d5dc8 --- /dev/null +++ b/doc/api/user_remove_principal.md @@ -0,0 +1,32 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# user_remove_principal +Remove principal alias from the user entry + +### Arguments +|Name|Type|Required +|-|-|- +|uid|:ref:`Str`|True +|krbprincipalname|:ref:`Principal`|True + +### Options +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* no_members : :ref:`Flag` **(Required)** + * Default: False +* version : :ref:`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 \ No newline at end of file diff --git a/doc/api/user_show.md b/doc/api/user_show.md new file mode 100644 index 000000000..dd3b45b94 --- /dev/null +++ b/doc/api/user_show.md @@ -0,0 +1,34 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# user_show +Display information about a user. + +### Arguments +|Name|Type|Required +|-|-|- +|uid|:ref:`Str`|True + +### Options +* rights : :ref:`Flag` **(Required)** + * Default: False +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* no_members : :ref:`Flag` **(Required)** + * Default: False +* out : :ref:`Str` +* version : :ref:`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 \ No newline at end of file diff --git a/doc/api/user_stage.md b/doc/api/user_stage.md new file mode 100644 index 000000000..775687fd9 --- /dev/null +++ b/doc/api/user_stage.md @@ -0,0 +1,27 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# user_stage +Move deleted user into staged area + +### Arguments +|Name|Type|Required +|-|-|- +|uid|:ref:`Str`|True + +### Options +* continue : :ref:`Flag` **(Required)** + * Default: False +* version : :ref:`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 \ No newline at end of file diff --git a/doc/api/user_status.md b/doc/api/user_status.md new file mode 100644 index 000000000..375b0cc38 --- /dev/null +++ b/doc/api/user_status.md @@ -0,0 +1,50 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# user_status + +Lockout status of a user account + +An account may become locked if the password is entered incorrectly too +many times within a specific time period as controlled by password +policy. A locked account is a temporary condition and may be unlocked by +an administrator. + +This connects to each IPA master and displays the lockout status on +each one. + +To determine whether an account is locked on a given server you need +to compare the number of failed logins and the time of the last failure. +For an account to be locked it must exceed the maxfail failures within +the failinterval duration as specified in the password policy associated +with the user. + +The failed login counter is modified only when a user attempts a log in +so it is possible that an account may appear locked but the last failed +login attempt is older than the lockouttime of the password policy. This +means that the user may attempt a login again. + +### Arguments +|Name|Type|Required +|-|-|- +|useruid|:ref:`Str`|True + +### Options +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* version : :ref:`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 \ No newline at end of file diff --git a/doc/api/user_undel.md b/doc/api/user_undel.md new file mode 100644 index 000000000..5f0eed725 --- /dev/null +++ b/doc/api/user_undel.md @@ -0,0 +1,25 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# user_undel +Undelete a delete user account. + +### Arguments +|Name|Type|Required +|-|-|- +|uid|:ref:`Str`|True + +### Options +* version : :ref:`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 \ No newline at end of file diff --git a/doc/api/user_unlock.md b/doc/api/user_unlock.md new file mode 100644 index 000000000..f33ec2f8b --- /dev/null +++ b/doc/api/user_unlock.md @@ -0,0 +1,31 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# user_unlock + +Unlock a user account + +An account may become locked if the password is entered incorrectly too +many times within a specific time period as controlled by password +policy. A locked account is a temporary condition and may be unlocked by +an administrator. + +### Arguments +|Name|Type|Required +|-|-|- +|uid|:ref:`Str`|True + +### Options +* version : :ref:`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 \ No newline at end of file diff --git a/doc/api/vault_add_internal.md b/doc/api/vault_add_internal.md new file mode 100644 index 000000000..adbcd6be2 --- /dev/null +++ b/doc/api/vault_add_internal.md @@ -0,0 +1,43 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# vault_add_internal +Add a vault. + +### Arguments +|Name|Type|Required +|-|-|- +|cn|:ref:`Str`|True + +### Options +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* no_members : :ref:`Flag` **(Required)** + * Default: False +* description : :ref:`Str` +* ipavaulttype : :ref:`StrEnum` + * Default: symmetric + * Values: ('standard', 'symmetric', 'asymmetric') +* ipavaultsalt : :ref:`Bytes` +* ipavaultpublickey : :ref:`Bytes` +* setattr : :ref:`Str` +* addattr : :ref:`Str` +* service : :ref:`Principal` +* shared : :ref:`Flag` + * Default: False +* username : :ref:`Str` +* version : :ref:`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 \ No newline at end of file diff --git a/doc/api/vault_add_member.md b/doc/api/vault_add_member.md new file mode 100644 index 000000000..225299c6c --- /dev/null +++ b/doc/api/vault_add_member.md @@ -0,0 +1,38 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# vault_add_member +Add members to a vault. + +### Arguments +|Name|Type|Required +|-|-|- +|cn|:ref:`Str`|True + +### Options +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* no_members : :ref:`Flag` **(Required)** + * Default: False +* service : :ref:`Principal` +* shared : :ref:`Flag` + * Default: False +* username : :ref:`Str` +* version : :ref:`Str` +* user : :ref:`Str` +* group : :ref:`Str` +* services : :ref:`Str` + +### Output +|Name|Type +|-|- +|completed|Output +|failed|Output +|result|Entry + +[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end) +### Semantics + +### Notes + +### Version differences \ No newline at end of file diff --git a/doc/api/vault_add_owner.md b/doc/api/vault_add_owner.md new file mode 100644 index 000000000..e4544074a --- /dev/null +++ b/doc/api/vault_add_owner.md @@ -0,0 +1,38 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# vault_add_owner +Add owners to a vault. + +### Arguments +|Name|Type|Required +|-|-|- +|cn|:ref:`Str`|True + +### Options +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* no_members : :ref:`Flag` **(Required)** + * Default: False +* service : :ref:`Principal` +* shared : :ref:`Flag` + * Default: False +* username : :ref:`Str` +* version : :ref:`Str` +* user : :ref:`Str` +* group : :ref:`Str` +* services : :ref:`Str` + +### Output +|Name|Type +|-|- +|completed|Output +|failed|Output +|result|Entry + +[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end) +### Semantics + +### Notes + +### Version differences \ No newline at end of file diff --git a/doc/api/vault_archive_internal.md b/doc/api/vault_archive_internal.md new file mode 100644 index 000000000..169f5477a --- /dev/null +++ b/doc/api/vault_archive_internal.md @@ -0,0 +1,39 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# vault_archive_internal +Archive data into a vault. + +### Arguments +|Name|Type|Required +|-|-|- +|cn|:ref:`Str`|True + +### Options +* session_key : :ref:`Bytes` **(Required)** +* vault_data : :ref:`Bytes` **(Required)** +* nonce : :ref:`Bytes` **(Required)** +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* service : :ref:`Principal` +* shared : :ref:`Flag` + * Default: False +* username : :ref:`Str` +* wrapping_algo : :ref:`StrEnum` + * Default: aes-128-cbc + * Values: ('aes-128-cbc', 'des-ede3-cbc') +* version : :ref:`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 \ No newline at end of file diff --git a/doc/api/vault_del.md b/doc/api/vault_del.md new file mode 100644 index 000000000..1fd0ef967 --- /dev/null +++ b/doc/api/vault_del.md @@ -0,0 +1,31 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# vault_del +Delete a vault. + +### Arguments +|Name|Type|Required +|-|-|- +|cn|:ref:`Str`|True + +### Options +* continue : :ref:`Flag` **(Required)** + * Default: False +* service : :ref:`Principal` +* shared : :ref:`Flag` + * Default: False +* username : :ref:`Str` +* version : :ref:`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 \ No newline at end of file diff --git a/doc/api/vault_find.md b/doc/api/vault_find.md new file mode 100644 index 000000000..05b18e966 --- /dev/null +++ b/doc/api/vault_find.md @@ -0,0 +1,49 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# vault_find +Search for vaults. + +### Arguments +|Name|Type|Required +|-|-|- +|criteria|:ref:`Str`|False + +### Options +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* no_members : :ref:`Flag` **(Required)** + * Default: True +* cn : :ref:`Str` +* description : :ref:`Str` +* ipavaulttype : :ref:`StrEnum` + * Default: symmetric + * Values: ('standard', 'symmetric', 'asymmetric') +* timelimit : :ref:`Int` +* sizelimit : :ref:`Int` +* service : :ref:`Principal` +* shared : :ref:`Flag` + * Default: False +* username : :ref:`Str` +* services : :ref:`Flag` + * Default: False +* users : :ref:`Flag` + * Default: False +* version : :ref:`Str` +* pkey_only : :ref:`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 \ No newline at end of file diff --git a/doc/api/vault_mod_internal.md b/doc/api/vault_mod_internal.md new file mode 100644 index 000000000..a035c5936 --- /dev/null +++ b/doc/api/vault_mod_internal.md @@ -0,0 +1,46 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# vault_mod_internal +Modify a vault. + +### Arguments +|Name|Type|Required +|-|-|- +|cn|:ref:`Str`|True + +### Options +* rights : :ref:`Flag` **(Required)** + * Default: False +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* no_members : :ref:`Flag` **(Required)** + * Default: False +* description : :ref:`Str` +* ipavaulttype : :ref:`StrEnum` + * Default: symmetric + * Values: ('standard', 'symmetric', 'asymmetric') +* ipavaultsalt : :ref:`Bytes` +* ipavaultpublickey : :ref:`Bytes` +* setattr : :ref:`Str` +* addattr : :ref:`Str` +* delattr : :ref:`Str` +* service : :ref:`Principal` +* shared : :ref:`Flag` + * Default: False +* username : :ref:`Str` +* version : :ref:`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 \ No newline at end of file diff --git a/doc/api/vault_remove_member.md b/doc/api/vault_remove_member.md new file mode 100644 index 000000000..c2c0d638d --- /dev/null +++ b/doc/api/vault_remove_member.md @@ -0,0 +1,38 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# vault_remove_member +Remove members from a vault. + +### Arguments +|Name|Type|Required +|-|-|- +|cn|:ref:`Str`|True + +### Options +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* no_members : :ref:`Flag` **(Required)** + * Default: False +* service : :ref:`Principal` +* shared : :ref:`Flag` + * Default: False +* username : :ref:`Str` +* version : :ref:`Str` +* user : :ref:`Str` +* group : :ref:`Str` +* services : :ref:`Str` + +### Output +|Name|Type +|-|- +|completed|Output +|failed|Output +|result|Entry + +[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end) +### Semantics + +### Notes + +### Version differences \ No newline at end of file diff --git a/doc/api/vault_remove_owner.md b/doc/api/vault_remove_owner.md new file mode 100644 index 000000000..26d01fb61 --- /dev/null +++ b/doc/api/vault_remove_owner.md @@ -0,0 +1,38 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# vault_remove_owner +Remove owners from a vault. + +### Arguments +|Name|Type|Required +|-|-|- +|cn|:ref:`Str`|True + +### Options +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* no_members : :ref:`Flag` **(Required)** + * Default: False +* service : :ref:`Principal` +* shared : :ref:`Flag` + * Default: False +* username : :ref:`Str` +* version : :ref:`Str` +* user : :ref:`Str` +* group : :ref:`Str` +* services : :ref:`Str` + +### Output +|Name|Type +|-|- +|completed|Output +|failed|Output +|result|Entry + +[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end) +### Semantics + +### Notes + +### Version differences \ No newline at end of file diff --git a/doc/api/vault_retrieve_internal.md b/doc/api/vault_retrieve_internal.md new file mode 100644 index 000000000..edc35ca37 --- /dev/null +++ b/doc/api/vault_retrieve_internal.md @@ -0,0 +1,37 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# vault_retrieve_internal +Retrieve data from a vault. + +### Arguments +|Name|Type|Required +|-|-|- +|cn|:ref:`Str`|True + +### Options +* session_key : :ref:`Bytes` **(Required)** +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* service : :ref:`Principal` +* shared : :ref:`Flag` + * Default: False +* username : :ref:`Str` +* wrapping_algo : :ref:`StrEnum` + * Default: aes-128-cbc + * Values: ('aes-128-cbc', 'des-ede3-cbc') +* version : :ref:`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 \ No newline at end of file diff --git a/doc/api/vault_show.md b/doc/api/vault_show.md new file mode 100644 index 000000000..1f1ede265 --- /dev/null +++ b/doc/api/vault_show.md @@ -0,0 +1,37 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# vault_show +Display information about a vault. + +### Arguments +|Name|Type|Required +|-|-|- +|cn|:ref:`Str`|True + +### Options +* rights : :ref:`Flag` **(Required)** + * Default: False +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* no_members : :ref:`Flag` **(Required)** + * Default: False +* service : :ref:`Principal` +* shared : :ref:`Flag` + * Default: False +* username : :ref:`Str` +* version : :ref:`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 \ No newline at end of file diff --git a/doc/api/vaultconfig_show.md b/doc/api/vaultconfig_show.md new file mode 100644 index 000000000..1e171f0d1 --- /dev/null +++ b/doc/api/vaultconfig_show.md @@ -0,0 +1,28 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# vaultconfig_show +Show vault configuration. + +### Arguments +No arguments. + +### Options +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* transport_out : :ref:`Str` +* version : :ref:`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 \ No newline at end of file diff --git a/doc/api/vaultcontainer_add_owner.md b/doc/api/vaultcontainer_add_owner.md new file mode 100644 index 000000000..709d516a0 --- /dev/null +++ b/doc/api/vaultcontainer_add_owner.md @@ -0,0 +1,36 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# vaultcontainer_add_owner +Add owners to a vault container. + +### Arguments +No arguments. + +### Options +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* no_members : :ref:`Flag` **(Required)** + * Default: False +* service : :ref:`Principal` +* shared : :ref:`Flag` + * Default: False +* username : :ref:`Str` +* version : :ref:`Str` +* user : :ref:`Str` +* group : :ref:`Str` +* services : :ref:`Str` + +### Output +|Name|Type +|-|- +|completed|Output +|failed|Output +|result|Entry + +[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end) +### Semantics + +### Notes + +### Version differences \ No newline at end of file diff --git a/doc/api/vaultcontainer_del.md b/doc/api/vaultcontainer_del.md new file mode 100644 index 000000000..421912175 --- /dev/null +++ b/doc/api/vaultcontainer_del.md @@ -0,0 +1,29 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# vaultcontainer_del +Delete a vault container. + +### Arguments +No arguments. + +### Options +* continue : :ref:`Flag` **(Required)** + * Default: False +* service : :ref:`Principal` +* shared : :ref:`Flag` + * Default: False +* username : :ref:`Str` +* version : :ref:`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 \ No newline at end of file diff --git a/doc/api/vaultcontainer_remove_owner.md b/doc/api/vaultcontainer_remove_owner.md new file mode 100644 index 000000000..2de54f24f --- /dev/null +++ b/doc/api/vaultcontainer_remove_owner.md @@ -0,0 +1,36 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# vaultcontainer_remove_owner +Remove owners from a vault container. + +### Arguments +No arguments. + +### Options +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* no_members : :ref:`Flag` **(Required)** + * Default: False +* service : :ref:`Principal` +* shared : :ref:`Flag` + * Default: False +* username : :ref:`Str` +* version : :ref:`Str` +* user : :ref:`Str` +* group : :ref:`Str` +* services : :ref:`Str` + +### Output +|Name|Type +|-|- +|completed|Output +|failed|Output +|result|Entry + +[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end) +### Semantics + +### Notes + +### Version differences \ No newline at end of file diff --git a/doc/api/vaultcontainer_show.md b/doc/api/vaultcontainer_show.md new file mode 100644 index 000000000..41fc44be3 --- /dev/null +++ b/doc/api/vaultcontainer_show.md @@ -0,0 +1,35 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# vaultcontainer_show +Display information about a vault container. + +### Arguments +No arguments. + +### Options +* rights : :ref:`Flag` **(Required)** + * Default: False +* all : :ref:`Flag` **(Required)** + * Default: False +* raw : :ref:`Flag` **(Required)** + * Default: False +* no_members : :ref:`Flag` **(Required)** + * Default: False +* service : :ref:`Principal` +* shared : :ref:`Flag` + * Default: False +* username : :ref:`Str` +* version : :ref:`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 \ No newline at end of file diff --git a/doc/api/whoami.md b/doc/api/whoami.md new file mode 100644 index 000000000..f7a352972 --- /dev/null +++ b/doc/api/whoami.md @@ -0,0 +1,23 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +# whoami +Describe currently authenticated identity. + +### Arguments +No arguments. + +### Options +* version : :ref:`Str` + +### Output +|Name|Type +|-|- +|arguments|Output +|command|Output +|object|Output + +[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end) +### Semantics + +### Notes + +### Version differences \ No newline at end of file diff --git a/doc/conf.py b/doc/conf.py index a66c1c10b..ab6806a3d 100644 --- a/doc/conf.py +++ b/doc/conf.py @@ -19,14 +19,14 @@ sys.path.insert(0, os.path.abspath('..')) # -- Project information ----------------------------------------------------- project = 'FreeIPA' -copyright = '2020, FreeIPA Contributors' +copyright = '2022, FreeIPA Contributors' author = 'FreeIPA Contributors' # The short X.Y version -version = '4.9-dev' +version = '4.11-dev' # The full version, including alpha/beta/rc tags -release = '4.9-dev' +release = '4.11-dev' master_doc = 'index' diff --git a/doc/index.rst b/doc/index.rst index 7bafde02d..95ccf6dca 100644 --- a/doc/index.rst +++ b/doc/index.rst @@ -30,6 +30,7 @@ installation and configuration tasks. designs/index.rst workshop.rst + api/index.rst Indices and tables diff --git a/ipaserver/plugins/idrange.py b/ipaserver/plugins/idrange.py index 3e486b8e2..d5b184fcd 100644 --- a/ipaserver/plugins/idrange.py +++ b/ipaserver/plugins/idrange.py @@ -40,7 +40,7 @@ else: _dcerpc_bindings_installed = False -ID_RANGE_VS_DNA_WARNING = _("""======= +ID_RANGE_VS_DNA_WARNING = _("""------- WARNING: DNA plugin in 389-ds will allocate IDs based on the ranges configured for the @@ -51,7 +51,8 @@ Manual configuration change has to be done in the DNA plugin configuration for the new local range. Specifically, The dnaNextRange attribute of 'cn=Posix IDs,cn=Distributed Numeric Assignment Plugin,cn=plugins,cn=config' has to be modified to match the new range. -======= + +------- """) __doc__ = _(""" diff --git a/makeapi.in b/makeapi.in index e6c1d3ddb..100e5c0f6 100644 --- a/makeapi.in +++ b/makeapi.in @@ -268,6 +268,145 @@ def make_api(): return 0 +def make_api_reference(): + """ + Generate API reference. + Index will be created in reStructuredText format so that it can be + integrated in existing documentation. Then, reference for each class + will be created in Markdown format. + """ + + class_template = """[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) +{reference} + +[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end) +{notes} +""" + + notes_template = """### Semantics + +### Notes + +### Version differences +""" + + def make_md_table(rows): + """ + First list passed are column names, the rest are rows. + Return list of lines conforming the table. + """ + out = ["|" + "|".join(rows[0])] + out.append("|" + "|".join(['-'] * len(rows[0]))) + for row in rows[1:]: + out.append("|" + "|".join(row)) + return out + + cmd_lines = [ + "IPA API Commands", + "=================", + ".. toctree::", + " :maxdepth: 1", + "\n" + ] + + param_lines = [ + "IPA API Parameter types", + "=======================", + ".. toctree::", + " :maxdepth: 1", + "\n" + ] + + # Create Markdown file for each parameter type under ipalib.parameters.Param + def all_subclasses(cls): + ret = cls.__subclasses__() + for s in cls.__subclasses__(): + ret.extend(all_subclasses(s)) + return sorted(list(set(ret)), key=operator.attrgetter('__name__')) + + ipa_classes = all_subclasses(Param) + + for param in ipa_classes: + lines = [ + ".. _%s:\n" % param.__name__, + "# %s" % param.__name__, + ] + with open("doc/api/%s.md" % param.__name__, "w") as f: + out = "\n".join(lines) + f.write(out) + param_lines.append(" %s.md" % param.__name__) + + def generate_param_type_text(obj): + # If class is part of IPA Params, return text with ref, if not just return its name + if type(obj) in ipa_classes: + return ":ref:`{n}<{n}>`".format(n=type(obj).__name__) + else: + return type(obj).__name__ + + # Create Markdown file for each command + for cmd in api.Command(): + lines = [] + lines.append("# %s" % cmd.name) + + doc_stripped = '\n'.join([s.strip() for s in str(cmd.doc).splitlines()]) + lines.append(doc_stripped) + + lines.append("\n### Arguments") + try: + next(cmd.args()) # if empty, StopIteration is thrown + table_rows = [["Name", "Type", "Required"]] + for a in cmd.args(): + table_rows.append([a.name, generate_param_type_text(a), str(a.required)]) + lines.extend(make_md_table(table_rows)) + except StopIteration: + lines.append("No arguments.") + + lines.append("\n### Options") + try: + next(cmd.options()) + for o in sorted(cmd.options(), key=operator.attrgetter('required'), reverse=True): + req_str = " **(Required)**" if o.required else "" + lines.append("* {} : {}{}".format(o.name, generate_param_type_text(o), req_str)) + if hasattr(o, "default") and o.default is not None: + lines.append(" * Default: {}".format(o.default)) + if hasattr(o, "values"): + lines.append(" * Values: {}".format(o.values)) + except StopIteration: + lines.append("No options.") + + lines.append("\n### Output") + try: + next(cmd.output()) + table_rows = [["Name", "Type"]] + for o in sorted(cmd.output(), key=operator.attrgetter('name')): + table_rows.append([o.name, generate_param_type_text(o)]) + lines.extend(make_md_table(table_rows)) + except StopIteration: + lines.append("No output.") + + cmd_lines.append(" %s.md" % cmd.name) + + try: + with open("doc/api/%s.md" % cmd.name, "r") as f: + # Read notes write to template + notes = f.read().split("//end)")[1].strip() + except FileNotFoundError: + notes = notes_template + + with open("doc/api/%s.md" % cmd.name, "w") as f: + out = class_template.format( + reference="\n".join(lines), notes=notes).strip() + f.write(out) + + with open("doc/api/commands.rst", "w") as f: + f.write("\n".join(cmd_lines)) + + with open("doc/api/parameters.rst", "w") as f: + f.write("\n".join(param_lines)) + + return 0 + + def find_name(line): """ Break apart a Param line and pull out the name. It would be nice if we @@ -526,6 +665,8 @@ def main(): else: print("Writing API to API.txt") rval |= make_api() + print("Creating API Reference") + rval |= make_api_reference() if rval & API_FILE_DIFFERENCE: print('')