freeipa.ansible_freeipa.ipatopologysegment (1.11.1) — module

Manage FreeIPA topology segments

Authors: Thomas Woerner (@t-woerner)

preview | supported by community

Install collection

Install with ansible-galaxy collection install freeipa.ansible_freeipa:==1.11.1


Add to requirements.yml

  collections:
    - name: freeipa.ansible_freeipa
      version: 1.11.1

Description

Manage FreeIPA topology segments

Usage examples

1
  • Hint
    Tasks should always be named using the name parameter.
- freeipa.ansible_freeipa.ipatopologysegment:
    ipaadmin_password: SomeADMINpassword
    suffix: domain
    left: ipaserver.test.local
    right: ipareplica1.test.local
    state: present
1
  • Hint
    Tasks should always be named using the name parameter.
- freeipa.ansible_freeipa.ipatopologysegment:
    ipaadmin_password: SomeADMINpassword
    suffix: domain
    name: ipaserver.test.local-to-replica1.test.local
    state: absent
1
  • Hint
    Tasks should always be named using the name parameter.
- freeipa.ansible_freeipa.ipatopologysegment:
    ipaadmin_password: SomeADMINpassword
    suffix: domain
    left: ipaserver.test.local
    right: ipareplica1.test.local
    state: absent
1
  • Hint
    Tasks should always be named using the name parameter.
- freeipa.ansible_freeipa.ipatopologysegment:
    ipaadmin_password: SomeADMINpassword
    suffix: ca
    name: ipaserver.test.local-to-replica1.test.local
    direction: left-to-right
    state: reinitialized
1
  • Hint
    Tasks should always be named using the name parameter.
- freeipa.ansible_freeipa.ipatopologysegment:
    ipaadmin_password: SomeADMINpassword
    suffix: domain+ca
    left: ipaserver.test.local
    right: ipareplica1.test.local
    state: absent
1
  • Hint
    Tasks should always be named using the name parameter.
- freeipa.ansible_freeipa.ipatopologysegment:
    ipaadmin_password: SomeADMINpassword
    suffix: domain+ca
    left: ipaserver.test.local
    right: ipareplica1.test.local
    state: checked

Inputs

    
left:
    aliases:
    - leftnode
    description: Left replication node - an IPA server
    required: false
    type: str

name:
    aliases:
    - cn
    description: Topology segment name, unique identifier.
    required: false
    type: str

right:
    aliases:
    - rightnode
    description: Right replication node - an IPA server
    required: false
    type: str

state:
    choices:
    - present
    - absent
    - enabled
    - disabled
    - reinitialized
    - checked
    default: present
    description: State to ensure
    type: str

suffix:
    choices:
    - domain
    - ca
    - domain+ca
    description: Topology suffix
    required: true
    type: str

direction:
    choices:
    - left-to-right
    - right-to-left
    description: The direction a segment will be reinitialized
    required: false
    type: str

ipaapi_context:
    choices:
    - server
    - client
    description: 'The context in which the module will execute. Executing in a

      server context is preferred. If not provided context will be

      determined by the execution environment.

      '
    required: false
    type: str

ipaadmin_password:
    description: The admin password.
    required: false
    type: str

ipaapi_ldap_cache:
    default: true
    description: Use LDAP cache for IPA connection.
    type: bool

ipaadmin_principal:
    default: admin
    description: The admin principal.
    type: str

Outputs

found:
  description: List of found segments
  returned: if state is checked
  type: list
not-found:
  description: List of not found segments
  returned: if state is checked
  type: list