freeipa.ansible_freeipa.ipaserver (1.11.1) — module

Manage FreeIPA server

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 server

Usage examples

1
  • Hint
    Tasks should always be named using the name parameter.
# Ensure server server.example.com is already present in the topology
- freeipa.ansible_freeipa.ipaserver:
    ipaadmin_password: SomeADMINpassword
    name: server.example.com
1
  • Hint
    Tasks should always be named using the name parameter.
# Ensure server server.example.com is absent from the topology
- freeipa.ansible_freeipa.ipaserver:
    ipaadmin_password: SomeADMINpassword
    name: server.example.com
    state: absent
1
  • Hint
    Tasks should always be named using the name parameter.
# Ensure server server.example.com has location mylocation
- freeipa.ansible_freeipa.ipaserver:
    ipaadmin_password: SomeADMINpassword
    name: server.example.com
    location: mylocation
1
  • Hint
    Tasks should always be named using the name parameter.
# Ensure server server.example.com does not have a location
- freeipa.ansible_freeipa.ipaserver:
    ipaadmin_password: SomeADMINpassword
    name: server.example.com
    location: ""
1
  • Hint
    Tasks should always be named using the name parameter.
# Ensure server server.example.com has service weight 1
- freeipa.ansible_freeipa.ipaserver:
    ipaadmin_password: SomeADMINpassword
    name: server.example.com
    service_weight: 1
1
  • Hint
    Tasks should always be named using the name parameter.
# Ensure server server.example.com does not have a service weight
- freeipa.ansible_freeipa.ipaserver:
    ipaadmin_password: SomeADMINpassword
    name: server.example.com
    service_weight: -1
1
  • Hint
    Tasks should always be named using the name parameter.
# Ensure server server.example.com is hidden
- freeipa.ansible_freeipa.ipaserver:
    ipaadmin_password: SomeADMINpassword
    name: server.example.com
    hidden: yes
1
  • Hint
    Tasks should always be named using the name parameter.
# Ensure server server.example.com is not hidden
- freeipa.ansible_freeipa.ipaserver:
    ipaadmin_password: SomeADMINpassword
    name: server.example.com
    hidden: no
2
  • Hint
    Parameter 'continue' is an alias for parameter 'delete_continue' in module 'freeipa.ansible_freeipa.ipaserver'.
  • Hint
    Tasks should always be named using the name parameter.
# Ensure server server.example.com is absent from the topology in continuous
# mode to ignore errors
- freeipa.ansible_freeipa.ipaserver:
    ipaadmin_password: SomeADMINpassword
    name: server.example.com
    continue: yes
    state: absent
1
  • Hint
    Tasks should always be named using the name parameter.
# Ensure server "server.example.com" is absent from the topology with skipping
# the last of role check
- freeipa.ansible_freeipa.ipaserver:
    ipaadmin_password: SomeADMINpassword
    name: server.example.com
    ignore_last_of_role: yes
    state: absent
1
  • Hint
    Tasks should always be named using the name parameter.
# Ensure server server "server.example.com" is absent from the topology with
# skipping the topology disconnect check
- freeipa.ansible_freeipa.ipaserver:
    ipaadmin_password: SomeADMINpassword
    name: server.example.com
    ignore_topology_disconnect: yes
    state: absent
1
  • Hint
    Tasks should always be named using the name parameter.
# Ensure server server.example.com is absent in force mode
- freeipa.ansible_freeipa.ipaserver:
    ipaadmin_password: SomeADMINpassword
    name: server.example.com
    force: yes
    state: absent

Inputs

    
name:
    aliases:
    - cn
    description: The list of server name strings.
    elements: str
    required: true
    type: list

force:
    description: 'Force server removal even if it does not exist.

      Will always result in changed.

      Only available with ''state: absent''.

      '
    required: false
    type: bool

state:
    choices:
    - present
    - absent
    default: present
    description: The state to ensure.
    required: false
    type: str

hidden:
    description: 'Set hidden state of a server.

      Only available with ''state: present''.

      '
    required: false
    type: bool

location:
    aliases:
    - ipalocation_location
    description: 'The server DNS location.

      Only available with ''state: present''.

      Use "" for location reset.

      '
    required: false
    type: str

no_members:
    description: 'Suppress processing of membership attributes

      Only available with ''state: present''.

      '
    required: false
    type: bool

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

service_weight:
    aliases:
    - ipaserviceweight
    description: 'Weight for server services

      Values 0 to 65535, -1 for weight reset.

      Only available with ''state: present''.

      '
    required: false
    type: int

delete_continue:
    aliases:
    - continue
    description: 'Continuous mode: Don''t stop on errors.

      Only available with ''state: absent''.

      '
    required: false
    type: bool

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

ignore_last_of_role:
    description: 'Skip a check whether the last CA master or DNS server is removed.

      Only available with ''state: absent''.

      '
    required: false
    type: bool

ignore_topology_disconnect:
    description: 'Ignore topology connectivity problems after removal.

      Only available with ''state: absent''.

      '
    required: false
    type: bool