Import Upstream version 4.12.4

This commit is contained in:
geos_one
2025-08-12 22:28:56 +02:00
parent 03a8170b15
commit 9181ee2487
1629 changed files with 874094 additions and 554378 deletions

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

@@ -0,0 +1,7 @@
[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.)
.. _A6Record:
# A6Record
[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end)
A6 DNS record.

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

@@ -0,0 +1,7 @@
[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.)
.. _AAAARecord:
# AAAARecord
[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end)
AAAA DNS record.

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

@@ -0,0 +1,7 @@
[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.)
.. _AFSDBRecord:
# AFSDBRecord
[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end)
AFSDB DNS record.

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

@@ -0,0 +1,7 @@
[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.)
.. _APLRecord:
# APLRecord
[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end)
APL DNS record.

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

@@ -0,0 +1,7 @@
[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.)
.. _ARecord:
# ARecord
[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end)
A DNS record.

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

@@ -0,0 +1,9 @@
[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.)
.. _AccessTime:
# AccessTime
[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end)
Access time parameter type.
Accepts values conforming to generalizedTime as defined in RFC 4517 section 3.3.13 without time zone information.

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

@@ -0,0 +1,7 @@
[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.)
.. _Any:
# Any
[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end)
A parameter capable of holding values of any type. For internal use only.

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

@@ -0,0 +1,7 @@
[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.)
.. _BinaryFile:
# BinaryFile
[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end)
Binary file parameter type.

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

@@ -0,0 +1,7 @@
[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.)
.. _Bool:
# Bool
[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end)
A parameter for boolean values (stored in the ``bool`` type).

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

@@ -0,0 +1,11 @@
[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.)
.. _Bytes:
# Bytes
[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end)
A parameter for binary data (stored in the ``str`` type).
This class is named *Bytes* instead of *Str* so it's aligned with the
Python v3 ``(str, unicode) => (bytes, str)`` clean-up.
See: http://docs.python.org/3.0/whatsnew/3.0.html
Also see the `Str` parameter.

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

@@ -0,0 +1,7 @@
[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.)
.. _BytesEnum:
# BytesEnum
[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end)
Enumerable for binary data (stored in the ``str`` type).

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

@@ -0,0 +1,7 @@
[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.)
.. _CERTRecord:
# CERTRecord
[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end)
CERT DNS record.

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

@@ -0,0 +1,7 @@
[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.)
.. _CNAMERecord:
# CNAMERecord
[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end)
CNAME DNS record.

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

@@ -0,0 +1,5 @@
[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.)
.. _Certificate:
# Certificate
[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end)

View File

@@ -0,0 +1,5 @@
[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.)
.. _CertificateSigningRequest:
# CertificateSigningRequest
[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end)

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

@@ -0,0 +1,7 @@
[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.)
.. _DHCIDRecord:
# DHCIDRecord
[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end)
DHCID DNS record.

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

@@ -0,0 +1,7 @@
[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.)
.. _DLVRecord:
# DLVRecord
[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end)
DLV DNS record.

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

@@ -0,0 +1,7 @@
[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.)
.. _DNAMERecord:
# DNAMERecord
[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end)
DNAME DNS record.

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

@@ -0,0 +1,9 @@
[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.)
.. _DNOrURL:
# DNOrURL
[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end)
DN parameter that allows, and strips, a "ldap:///" prefix on input.
Used for ``subtree`` to maintain backward compatibility.

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

@@ -0,0 +1,7 @@
[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.)
.. _DNParam:
# DNParam
[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end)
LDAP DN.

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

@@ -0,0 +1,10 @@
[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.)
.. _DNSNameParam:
# DNSNameParam
[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end)
Domain name parameter type.
* `only_absolute`: a domain name has to be absolute (makes it absolute from unicode input)
* `only_relative`: a domain name has to be relative

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

@@ -0,0 +1,7 @@
[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.)
.. _DNSRecord:
# DNSRecord
[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end)
Base class for DNS records, subclass of `Str`.

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

@@ -0,0 +1,7 @@
[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.)
.. _DSRecord:
# DSRecord
[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end)
DS DNS record.

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

@@ -0,0 +1,11 @@
[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.)
.. _Data:
# Data
[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end)
Base class for the `Bytes` and `Str` parameters.
Previously `Str` was as subclass of `Bytes`. Now the common functionality
has been split into this base class so that ``isinstance(foo, Bytes)`` wont
be ``True`` when ``foo`` is actually an `Str` instance (which is confusing).

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

@@ -0,0 +1,19 @@
[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.)
.. _DateTime:
# DateTime
[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end)
DateTime parameter type.
Accepts LDAP Generalized time without in the following format:
'%Y%m%d%H%M%SZ'
Accepts subset of values defined by ISO 8601:
'%Y-%m-%dT%H:%M:%SZ'
'%Y-%m-%dT%H:%MZ'
'%Y-%m-%dZ'
Also accepts above formats using ' ' (space) as a separator instead of 'T'.
Refer to the `man strftime` for the explanations for the %Y,%m,%d,%H.%M,%S.

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

@@ -0,0 +1,12 @@
[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.)
.. _Decimal:
# Decimal
[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end)
A parameter for floating-point values (stored in the ``Decimal`` type).
Python Decimal type helps overcome problems tied to plain "float" type,
e.g. problem with representation or value comparison. In order to safely
transfer the value over RPC libraries, it is being converted to string
which is then converted back to Decimal number.

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

@@ -0,0 +1,7 @@
[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.)
.. _Dict:
# Dict
[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end)
A parameter for dictionary.

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

@@ -0,0 +1,7 @@
[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.)
.. _Enum:
# Enum
[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end)
Base class for parameters with enumerable values.

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

@@ -0,0 +1,9 @@
[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.)
.. _File:
# File
[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end)
Text file parameter type.
Accepts file names and loads their content into the parameter value.

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

@@ -0,0 +1,37 @@
[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.)
.. _Flag:
# Flag
[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end)
A boolean parameter that always gets filled in with a default value.
This `Bool` subclass forces ``autofill=True`` in `Flag.__init__()`. If no
default is provided, it also fills in a default value of ``False``.
Lastly, unlike the `Bool` class, the default must be either ``True`` or
``False`` and cannot be ``None``.
For example:
```
>>> flag = Flag('my_flag')
>>> (flag.autofill, flag.default)
(True, False)
```
To have a default value of ``True``, create your `Flag` intance with
``default=True``. For example:
```
>>> flag = Flag('my_flag', default=True)
>>> (flag.autofill, flag.default)
(True, True)
```
Also note that creating a `Flag` instance with ``autofill=False`` will have
no effect. For example:
```
>>> flag = Flag('my_flag', autofill=False)
>>> flag.autofill
True
```

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

@@ -0,0 +1,7 @@
[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.)
.. _ForwardRecord:
# ForwardRecord
[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end)
Forward DNS record.

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

@@ -0,0 +1,7 @@
[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.)
.. _HINFORecord:
# HINFORecord
[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end)
HINFO DNS record.

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

@@ -0,0 +1,7 @@
[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.)
.. _HIPRecord:
# HIPRecord
[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end)
HIP DNS record.

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

@@ -0,0 +1,11 @@
[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.)
.. _HostPassword:
# HostPassword
[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end)
A data type for host passwords to not log password values.
The `Password` type cannot be used because it disallows
setting a password on the command-line which would break
backwards compatibility.

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

@@ -0,0 +1,7 @@
[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.)
.. _IA5Str:
# IA5Str
[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end)
An IA5String per RFC 4517.

View File

@@ -0,0 +1,7 @@
[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.)
.. _IPSECKEYRecord:
# IPSECKEYRecord
[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end)
IPSECKEY DNS record.

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

@@ -0,0 +1,7 @@
[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.)
.. _Int:
# Int
[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end)
A parameter for integer values (stored in the ``int`` type).

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

@@ -0,0 +1,7 @@
[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.)
.. _IntEnum:
# IntEnum
[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end)
Enumerable for integer data (stored in the ``int`` type).

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

@@ -0,0 +1,7 @@
[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.)
.. _KEYRecord:
# KEYRecord
[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end)
KEY DNS record.

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

@@ -0,0 +1,7 @@
[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.)
.. _KXRecord:
# KXRecord
[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end)
KX DNS record.

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

@@ -0,0 +1,7 @@
[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.)
.. _LOCRecord:
# LOCRecord
[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end)
LOC DNS record.

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

@@ -0,0 +1,7 @@
[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.)
.. _MDRecord:
# MDRecord
[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end)
MD DNS record.

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

@@ -0,0 +1,7 @@
[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.)
.. _MINFORecord:
# MINFORecord
[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end)
MINFO DNS record.

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

@@ -0,0 +1,7 @@
[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.)
.. _MXRecord:
# MXRecord
[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end)
MX DNS record.

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

@@ -0,0 +1,7 @@
[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.)
.. _NAPTRRecord:
# NAPTRRecord
[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end)
NAPTR DNS record.

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

@@ -0,0 +1,7 @@
[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.)
.. _NSECRecord:
# NSECRecord
[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end)
NSEC DNS record.

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

@@ -0,0 +1,7 @@
[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.)
.. _NSRecord:
# NSRecord
[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end)
NS DNS record.

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

@@ -0,0 +1,7 @@
[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.)
.. _NXTRecord:
# NXTRecord
[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end)
NXT DNS record.

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

@@ -0,0 +1,7 @@
[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.)
.. _Number:
# Number
[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end)
Base class for the `Int` and `Decimal` parameters.

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

@@ -0,0 +1,7 @@
[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.)
.. _OTPTokenKey:
# OTPTokenKey
[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end)
A binary password type specified in base32.

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

@@ -0,0 +1,7 @@
[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.)
.. _PTRRecord:
# PTRRecord
[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end)
PTR DNS record.

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

@@ -0,0 +1,7 @@
[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.)
.. _Password:
# Password
[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end)
A parameter for passwords (stored in the ``unicode`` type).

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

@@ -0,0 +1,7 @@
[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.)
.. _Principal:
# Principal
[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end)
Kerberos principal name.

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

@@ -0,0 +1,7 @@
[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.)
.. _RPRecord:
# RPRecord
[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end)
RP DNS record.

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

@@ -0,0 +1,7 @@
[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.)
.. _RRSIGRecord:
# RRSIGRecord
[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end)
RRSIG DNS record.

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

@@ -0,0 +1,7 @@
[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.)
.. _SIGRecord:
# SIGRecord
[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end)
SIG DNS record.

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

@@ -0,0 +1,7 @@
[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.)
.. _SPFRecord:
# SPFRecord
[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end)
SPF DNS record.

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

@@ -0,0 +1,7 @@
[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.)
.. _SRVRecord:
# SRVRecord
[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end)
SRV DNS record.

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

@@ -0,0 +1,7 @@
[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.)
.. _SSHFPRecord:
# SSHFPRecord
[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end)
SSHFP DNS record.

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

@@ -0,0 +1,7 @@
[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.)
.. _SerialNumber:
# SerialNumber
[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end)
Certificate serial number parameter type.

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

@@ -0,0 +1,14 @@
[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.)
.. _Str:
# Str
[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end)
A parameter for Unicode text (stored in the ``unicode`` type).
This class is named `Str` instead of `Unicode` so it's aligned with the
Python v3 ``(str, unicode) => (bytes, str)`` clean-up.
See: http://docs.python.org/3.0/whatsnew/3.0.html
Also see the `Bytes` parameter.

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

@@ -0,0 +1,19 @@
[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.)
.. _StrEnum:
# StrEnum
[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end)
Enumerable for Unicode text (stored in the ``unicode`` type).
For example:
```
>>> enum = StrEnum('my_enum', values=(u'One', u'Two', u'Three'))
>>> enum.validate(u'Two', 'cli') is None
True
>>> enum.validate(u'Four', 'cli')
Traceback (most recent call last):
...
ValidationError: invalid 'my_enum': must be one of 'One', 'Two', 'Three'
```

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

@@ -0,0 +1,7 @@
[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.)
.. _TLSARecord:
# TLSARecord
[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end)
TLSA DNS record.

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

@@ -0,0 +1,7 @@
[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.)
.. _TXTRecord:
# TXTRecord
[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end)
TXT DNS record.

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

@@ -0,0 +1,7 @@
[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.)
.. _URIRecord:
# URIRecord
[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end)
URI DNS record.

View File

@@ -0,0 +1,8 @@
[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.)
.. _UnsupportedDNSRecord:
# UnsupportedDNSRecord
[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end)
Records which are not supported by IPA, but we allow to show them if LDAP
contains these records.

View File

@@ -0,0 +1,66 @@
# Access control examples
IPA provides a way to manage delegation of rights. Permissions allows to define
certain management actions, which can then be grouped in privileges. These
privileges can then be added to roles, which can be assigned to users and
groups.
- [Access control examples](#access-control-examples)
- [Managing permissions](#managing-permissions)
- [Managing privileges](#managing-privileges)
- [Managing roles](#managing-roles)
- [Assigning roles to users and groups](#assigning-roles-to-users-and-groups)
## Managing permissions
Add a permission for creating users.
```python
api.Command.permission_add("Create users", ipapermright='add', type='user')
```
Add a permission for managing group membership.
```python
api.Command.permission_add("Manage group membership", ipapermright='write', type='group', attrs="member")
```
## Managing privileges
Add a privilege for user creation process (creating user, adding it to groups,
manage user certificates).
```python
api.Command.permission_add("Create users", ipapermright='add', type='user')
api.Command.permission_add("Manage group membership", ipapermright='write', type='group', attrs="member")
api.Command.permission_add("Manage User certificates", ipapermright='write', type='user', attrs='usercertificate')
api.Command.privilege_add("User creation")
api.Command.privilege_add_permission("User creation", permission="Create users")
api.Command.privilege_add_permission("User creation", permission="Manage group membership")
api.Command.privilege_add_permission("User creation", permission="Manage User certificates")
```
## Managing roles
Add a role with the privilege created earlier.
```python
api.Command.role_add("usermanager", description="Users manager")
api.Command.role_add_privilege("usermanager", privilege="User creation")
```
## Assigning roles to users and groups
Assign the role `usermanager` to user `bob`.
```python
api.Command.role_add_member("usermanager", user="bob")
```
Users, groups, hosts and hostgroups may be members of a role. Assign the
`usermanager` role to `managers` group.
```python
api.Command.role_add_member("usermanager", group="managers")
```

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

@@ -0,0 +1,45 @@
[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.)
# aci_add
Create new ACI.
### Arguments
|Name|Type|Required
|-|-|-
|aciname|:ref:`Str<Str>`|True
### Options
* permissions : :ref:`Str<Str>` **(Required)**
* aciprefix : :ref:`StrEnum<StrEnum>` **(Required)**
* Values: ('permission', 'delegation', 'selfservice', 'none')
* all : :ref:`Flag<Flag>` **(Required)**
* Default: False
* raw : :ref:`Flag<Flag>` **(Required)**
* Default: False
* permission : :ref:`Str<Str>`
* group : :ref:`Str<Str>`
* attrs : :ref:`Str<Str>`
* type : :ref:`StrEnum<StrEnum>`
* Values: ('user', 'group', 'host', 'service', 'hostgroup', 'netgroup', 'dnsrecord')
* memberof : :ref:`Str<Str>`
* filter : :ref:`Str<Str>`
* subtree : :ref:`Str<Str>`
* targetgroup : :ref:`Str<Str>`
* selfaci : :ref:`Flag<Flag>`
* Default: False
* test : :ref:`Flag<Flag>`
* Default: False
* version : :ref:`Str<Str>`
### Output
|Name|Type
|-|-
|result|Entry
|summary|Output
|value|PrimaryKey
[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end)
### Semantics
### Notes
### Version differences

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

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

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

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

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

@@ -0,0 +1,43 @@
[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.)
# aci_mod
Modify ACI.
### Arguments
|Name|Type|Required
|-|-|-
|aciname|:ref:`Str<Str>`|True
### Options
* aciprefix : :ref:`StrEnum<StrEnum>` **(Required)**
* Values: ('permission', 'delegation', 'selfservice', 'none')
* all : :ref:`Flag<Flag>` **(Required)**
* Default: False
* raw : :ref:`Flag<Flag>` **(Required)**
* Default: False
* permission : :ref:`Str<Str>`
* group : :ref:`Str<Str>`
* permissions : :ref:`Str<Str>`
* attrs : :ref:`Str<Str>`
* type : :ref:`StrEnum<StrEnum>`
* Values: ('user', 'group', 'host', 'service', 'hostgroup', 'netgroup', 'dnsrecord')
* memberof : :ref:`Str<Str>`
* filter : :ref:`Str<Str>`
* subtree : :ref:`Str<Str>`
* targetgroup : :ref:`Str<Str>`
* selfaci : :ref:`Flag<Flag>`
* Default: False
* version : :ref:`Str<Str>`
### Output
|Name|Type
|-|-
|result|Entry
|summary|Output
|value|PrimaryKey
[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end)
### Semantics
### Notes
### Version differences

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

@@ -0,0 +1,44 @@
[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.)
# aci_rename
Rename an ACI.
### Arguments
|Name|Type|Required
|-|-|-
|aciname|:ref:`Str<Str>`|True
### Options
* aciprefix : :ref:`StrEnum<StrEnum>` **(Required)**
* Values: ('permission', 'delegation', 'selfservice', 'none')
* newname : :ref:`Str<Str>` **(Required)**
* all : :ref:`Flag<Flag>` **(Required)**
* Default: False
* raw : :ref:`Flag<Flag>` **(Required)**
* Default: False
* permission : :ref:`Str<Str>`
* group : :ref:`Str<Str>`
* permissions : :ref:`Str<Str>`
* attrs : :ref:`Str<Str>`
* type : :ref:`StrEnum<StrEnum>`
* Values: ('user', 'group', 'host', 'service', 'hostgroup', 'netgroup', 'dnsrecord')
* memberof : :ref:`Str<Str>`
* filter : :ref:`Str<Str>`
* subtree : :ref:`Str<Str>`
* targetgroup : :ref:`Str<Str>`
* selfaci : :ref:`Flag<Flag>`
* Default: False
* version : :ref:`Str<Str>`
### Output
|Name|Type
|-|-
|result|Entry
|summary|Output
|value|PrimaryKey
[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end)
### Semantics
### Notes
### Version differences

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

@@ -0,0 +1,32 @@
[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.)
# aci_show
Display a single ACI given an ACI name.
### Arguments
|Name|Type|Required
|-|-|-
|aciname|:ref:`Str<Str>`|True
### Options
* aciprefix : :ref:`StrEnum<StrEnum>` **(Required)**
* Values: ('permission', 'delegation', 'selfservice', 'none')
* all : :ref:`Flag<Flag>` **(Required)**
* Default: False
* raw : :ref:`Flag<Flag>` **(Required)**
* Default: False
* location : :ref:`DNParam<DNParam>`
* version : :ref:`Str<Str>`
### Output
|Name|Type
|-|-
|result|Entry
|summary|Output
|value|PrimaryKey
[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end)
### Semantics
### Notes
### Version differences

View File

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

View File

@@ -0,0 +1,47 @@
# Differences between API and CLI usage
While the functionality between API and CLI is mostly the same, there are some
difference in their usage that should be taken into account.
- [Differences between API and CLI usage](#differences-between-api-and-cli-usage)
- [Command naming](#command-naming)
- [Parameter naming](#parameter-naming)
- [Date format](#date-format)
- [CLI-specific tools](#cli-specific-tools)
## Command naming
Commands in the CLI are constructed by specifying a topic and an action, with a
hyphen between them: `user-add`, `group-mod`, `host-del`. When accessing through
the API, the topic and the action are divided by an underscore instead:
`user_add`, `group_mod`, `host_del`. All available commands can be found below
`api.Command` after the API is initialized.
## Parameter naming
When managing plugins through the CLI, their parameters have different names
than the API, where names are the same as the LDAP attributes. For example,
`user-add` takes the `first` parameter in the CLI. However, this is named
`givenname` when calling `user_add` through the Python API.
## Date format
When passing dates through the CLI, multiple date string formats are available:
* %Y%m%d%H%M%SZ
* %Y-%m-%dT%H:%M:%SZ
* %Y-%m-%dT%H:%MZ
* %Y-%m-%dZ
* %Y-%m-%d %H:%M:%SZ
* %Y-%m-%d %H:%MZ
When using the API, apart from these formats, the Python built-in `datetime` class
can be used as well.
## CLI-specific tools
FreeIPA provides multiple tools that are mainly useful for CLI usage:
* `console`: starts an interactive Python console with an IPA API object already initialized.
* `help`: shows help about topics and commands, including examples for the CLI.
* `show-mappings`: shows the mapping between CLI parameter names and LDAP attributes.

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

@@ -0,0 +1,36 @@
[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.)
# automember_add
Add an automember rule.
### Arguments
|Name|Type|Required
|-|-|-
|cn|:ref:`Str<Str>`|True
### Options
* type : :ref:`StrEnum<StrEnum>` **(Required)**
* Values: ('group', 'hostgroup')
* all : :ref:`Flag<Flag>` **(Required)**
* Default: False
* raw : :ref:`Flag<Flag>` **(Required)**
* Default: False
* description : :ref:`Str<Str>`
* setattr : :ref:`Str<Str>`
* addattr : :ref:`Str<Str>`
* version : :ref:`Str<Str>`
### Output
|Name|Type
|-|-
|result|Entry
|summary|Output
|value|PrimaryKey
[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end)
### Semantics
### Notes
### Version differences

View File

@@ -0,0 +1,39 @@
[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.)
# automember_add_condition
Add conditions to an automember rule.
### Arguments
|Name|Type|Required
|-|-|-
|cn|:ref:`Str<Str>`|True
### Options
* key : :ref:`Str<Str>` **(Required)**
* type : :ref:`StrEnum<StrEnum>` **(Required)**
* Values: ('group', 'hostgroup')
* all : :ref:`Flag<Flag>` **(Required)**
* Default: False
* raw : :ref:`Flag<Flag>` **(Required)**
* Default: False
* description : :ref:`Str<Str>`
* automemberinclusiveregex : :ref:`Str<Str>`
* automemberexclusiveregex : :ref:`Str<Str>`
* version : :ref:`Str<Str>`
### Output
|Name|Type
|-|-
|completed|Output
|failed|Output
|result|Entry
|summary|Output
|value|PrimaryKey
[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end)
### Semantics
### Notes
### Version differences

View File

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

View File

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

View File

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

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

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

View File

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

View File

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

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

@@ -0,0 +1,39 @@
[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.)
# automember_mod
Modify an automember rule.
### Arguments
|Name|Type|Required
|-|-|-
|cn|:ref:`Str<Str>`|True
### Options
* rights : :ref:`Flag<Flag>` **(Required)**
* Default: False
* type : :ref:`StrEnum<StrEnum>` **(Required)**
* Values: ('group', 'hostgroup')
* all : :ref:`Flag<Flag>` **(Required)**
* Default: False
* raw : :ref:`Flag<Flag>` **(Required)**
* Default: False
* description : :ref:`Str<Str>`
* setattr : :ref:`Str<Str>`
* addattr : :ref:`Str<Str>`
* delattr : :ref:`Str<Str>`
* version : :ref:`Str<Str>`
### Output
|Name|Type
|-|-
|result|Entry
|summary|Output
|value|PrimaryKey
[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end)
### Semantics
### Notes
### Version differences

View File

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

View File

@@ -0,0 +1,39 @@
[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.)
# automember_remove_condition
Remove conditions from an automember rule.
### Arguments
|Name|Type|Required
|-|-|-
|cn|:ref:`Str<Str>`|True
### Options
* key : :ref:`Str<Str>` **(Required)**
* type : :ref:`StrEnum<StrEnum>` **(Required)**
* Values: ('group', 'hostgroup')
* all : :ref:`Flag<Flag>` **(Required)**
* Default: False
* raw : :ref:`Flag<Flag>` **(Required)**
* Default: False
* description : :ref:`Str<Str>`
* automemberinclusiveregex : :ref:`Str<Str>`
* automemberexclusiveregex : :ref:`Str<Str>`
* version : :ref:`Str<Str>`
### Output
|Name|Type
|-|-
|completed|Output
|failed|Output
|result|Entry
|summary|Output
|value|PrimaryKey
[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end)
### Semantics
### Notes
### Version differences

View File

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

View File

@@ -0,0 +1,34 @@
[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.)
# automountkey_add
Create a new automount key.
### Arguments
|Name|Type|Required
|-|-|-
|automountlocationcn|:ref:`Str<Str>`|True
|automountmapautomountmapname|:ref:`IA5Str<IA5Str>`|True
### Options
* automountkey : :ref:`IA5Str<IA5Str>` **(Required)**
* automountinformation : :ref:`IA5Str<IA5Str>` **(Required)**
* all : :ref:`Flag<Flag>` **(Required)**
* Default: False
* raw : :ref:`Flag<Flag>` **(Required)**
* Default: False
* setattr : :ref:`Str<Str>`
* addattr : :ref:`Str<Str>`
* version : :ref:`Str<Str>`
### Output
|Name|Type
|-|-
|result|Entry
|summary|Output
|value|PrimaryKey
[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end)
### Semantics
### Notes
### Version differences

View File

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

View File

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

View File

@@ -0,0 +1,39 @@
[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.)
# automountkey_mod
Modify an automount key.
### Arguments
|Name|Type|Required
|-|-|-
|automountlocationcn|:ref:`Str<Str>`|True
|automountmapautomountmapname|:ref:`IA5Str<IA5Str>`|True
### Options
* automountkey : :ref:`IA5Str<IA5Str>` **(Required)**
* rights : :ref:`Flag<Flag>` **(Required)**
* Default: False
* all : :ref:`Flag<Flag>` **(Required)**
* Default: False
* raw : :ref:`Flag<Flag>` **(Required)**
* Default: False
* automountinformation : :ref:`IA5Str<IA5Str>`
* setattr : :ref:`Str<Str>`
* addattr : :ref:`Str<Str>`
* delattr : :ref:`Str<Str>`
* newautomountinformation : :ref:`IA5Str<IA5Str>`
* version : :ref:`Str<Str>`
* rename : :ref:`Str<Str>`
### Output
|Name|Type
|-|-
|result|Entry
|summary|Output
|value|PrimaryKey
[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end)
### Semantics
### Notes
### Version differences

View File

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

View File

@@ -0,0 +1,31 @@
[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.)
# automountlocation_add
Create a new automount location.
### Arguments
|Name|Type|Required
|-|-|-
|cn|:ref:`Str<Str>`|True
### Options
* all : :ref:`Flag<Flag>` **(Required)**
* Default: False
* raw : :ref:`Flag<Flag>` **(Required)**
* Default: False
* setattr : :ref:`Str<Str>`
* addattr : :ref:`Str<Str>`
* version : :ref:`Str<Str>`
### Output
|Name|Type
|-|-
|result|Entry
|summary|Output
|value|PrimaryKey
[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end)
### Semantics
### Notes
### Version differences

View File

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

View File

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

View File

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

View File

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

View File

@@ -0,0 +1,33 @@
[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.)
# automountmap_add
Create a new automount map.
### Arguments
|Name|Type|Required
|-|-|-
|automountlocationcn|:ref:`Str<Str>`|True
|automountmapname|:ref:`IA5Str<IA5Str>`|True
### Options
* all : :ref:`Flag<Flag>` **(Required)**
* Default: False
* raw : :ref:`Flag<Flag>` **(Required)**
* Default: False
* description : :ref:`Str<Str>`
* setattr : :ref:`Str<Str>`
* addattr : :ref:`Str<Str>`
* version : :ref:`Str<Str>`
### Output
|Name|Type
|-|-
|result|Entry
|summary|Output
|value|PrimaryKey
[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end)
### Semantics
### Notes
### Version differences

View File

@@ -0,0 +1,36 @@
[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.)
# automountmap_add_indirect
Create a new indirect mount point.
### Arguments
|Name|Type|Required
|-|-|-
|automountlocationcn|:ref:`Str<Str>`|True
|automountmapname|:ref:`IA5Str<IA5Str>`|True
### Options
* key : :ref:`Str<Str>` **(Required)**
* all : :ref:`Flag<Flag>` **(Required)**
* Default: False
* raw : :ref:`Flag<Flag>` **(Required)**
* Default: False
* description : :ref:`Str<Str>`
* setattr : :ref:`Str<Str>`
* addattr : :ref:`Str<Str>`
* parentmap : :ref:`Str<Str>`
* Default: auto.master
* version : :ref:`Str<Str>`
### Output
|Name|Type
|-|-
|result|Entry
|summary|Output
|value|PrimaryKey
[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end)
### Semantics
### Notes
### Version differences

View File

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

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