IntenseWebs/freeipa
3
0
Fork 0
mirror of https://salsa.debian.org/freeipa-team/freeipa.git synced 2024-12-23 07:33:27 -06:00
Code Issues Packages Projects Releases Wiki Activity
d4ffc53b2a
freeipa/doc/api/trust_add.md
Antonio Torres 988cb5a535 doc: generate API Reference 
Extend the 'make api' target so that we also build an API Reference in
Markdown format. One template for each command gets generated. These
templates include all of the command details (arguments, options and
outputs), and then a section for manually-added notes such as semantics
or version differences. Every time the docs are regenerated, these notes
will be added if they exist.

Signed-off-by: Antonio Torres <antorres@redhat.com>
Reviewed-By: Alexander Bokovoy <abokovoy@redhat.com>
Reviewed-By: Rob Crittenden <rcritten@redhat.com>
2022-11-16 14:46:17 -05:00

1.7 KiB
Raw Blame History

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<Str> True

Options

  • trust_type : :ref:StrEnum<StrEnum> (Required)
  • Default: ad
  • Values: ('ad',)
  • all : :ref:Flag<Flag> (Required)
  • Default: False
  • raw : :ref:Flag<Flag> (Required)
  • Default: False
  • setattr : :ref:Str<Str>
  • addattr : :ref:Str<Str>
  • realm_admin : :ref:Str<Str>
  • realm_passwd : :ref:Password<Password>
  • realm_server : :ref:Str<Str>
  • trust_secret : :ref:Password<Password>
  • base_id : :ref:Int<Int>
  • range_size : :ref:Int<Int>
  • range_type : :ref:StrEnum<StrEnum>
  • Values: ('ipa-ad-trust', 'ipa-ad-trust-posix')
  • bidirectional : :ref:Bool<Bool>
  • Default: False
  • external : :ref:Bool<Bool>
  • Default: False
  • version : :ref:Str<Str>

Output

Name Type
result Entry
summary Output
value PrimaryKey

Semantics

Notes

Version differences