freeipa.ansible_freeipa.ipaclient_test (1.11.1) — module

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

Tries to discover IPA server using DNS or host name

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

# Complete autodiscovery, register return values as ipaclient_test
- name: IPA discovery
  freeipa.ansible_freeipa.ipaclient_test:
  register: register_ipaclient_test

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

# Discovery using servers, register return values as ipaclient_test
- name: IPA discovery
  freeipa.ansible_freeipa.ipaclient_test:
    servers: server1.domain.com,server2.domain.com
  register: register_ipaclient_test

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

# Discovery using domain name, register return values as ipaclient_test
- name: IPA discovery
  freeipa.ansible_freeipa.ipaclient_test:
    domain: domain.com
  register: register_ipaclient_test

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

# Discovery using realm, register return values as ipaclient_test
- name: IPA discovery
  freeipa.ansible_freeipa.ipaclient_test:
    realm: DOMAIN.COM
  register: register_ipaclient_test

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

# Discovery using hostname, register return values as ipaclient_test
- name: IPA discovery
  freeipa.ansible_freeipa.ipaclient_test:
    hostname: host.domain.com
  register: register_ipaclient_test

Inputs

    
realm:
    description: Kerberos realm name of the IPA deployment
    required: false
    type: str

domain:
    description: Primary DNS domain of the IPA deployment
    required: false
    type: str

no_ntp:
    default: false
    description: Do not configure ntp
    required: false
    type: bool

servers:
    description: Fully qualified name of IPA servers to enroll to
    elements: str
    required: false
    type: list

hostname:
    description: Fully qualified name of this host
    required: false
    type: str

ntp_pool:
    description: ntp server pool to use
    required: false
    type: str

nisdomain:
    description: The NIS domain name
    required: false
    type: str

on_master:
    default: false
    description: Whether the configuration is done on the master or not
    required: false
    type: bool

force_ntpd:
    default: false
    description: Stop and disable any time&date synchronization services besides ntpd
      Deprecated since 4.7
    required: false
    type: bool

firefox_dir:
    description: Specify directory where Firefox is installed (for example '/usr/lib/firefox')
    required: false
    type: str

ntp_servers:
    description: ntp servers to use
    elements: str
    required: false
    type: list

ip_addresses:
    description: List of Master Server IP Addresses
    elements: str
    required: false
    type: list

no_nisdomain:
    default: false
    description: Do not configure NIS domain name
    required: false
    type: bool

ca_cert_files:
    description: List of files containing CA certificates for the service certificate
      files
    elements: str
    required: false
    type: list

kinit_attempts:
    description: Repeat the request for host Kerberos ticket X times
    required: false
    type: int

all_ip_addresses:
    default: false
    description: All routable IP addresses configured on any interface will be added to
      DNS
    required: false
    type: bool

configure_firefox:
    default: false
    description: Configure Firefox to use IPA domain credentials
    required: false
    type: bool

enable_dns_updates:
    default: false
    description: Configures the machine to attempt dns updates when the ip address changes
    required: false
    type: bool

Outputs

basedn:
  description: The basedn of the detected IPA server.
  returned: always
  sample: dc=example,dc=com
  type: str
client_domain:
  description: The domain name of the client.
  returned: always
  sample: example.com
  type: str
dnsok:
  description: True if DNS discovery worked and not passed in any servers.
  returned: always
  type: bool
domain:
  description: The DNS domain of the detected or passed in IPA deployment.
  returned: always
  sample: example.com
  type: str
hostname:
  description: The detected or passed in FQDN hostname of the client.
  returned: always
  sample: client1.example.com
  type: str
ipa_python_version:
  description: 'The IPA python version as a number: <major version>*10000+<minor version>*100+<release>

    '
  returned: always
  sample: 16640
  type: int
kdc:
  description: The detected KDC server name.
  returned: always
  sample: server1.example.com
  type: str
nosssd_files:
  description: 'The dist of nss_ldap or nss-pam-ldapd files if sssd is disabled

    '
  elements: str
  returned: always
  type: list
ntp_servers:
  description: The list of detected NTP servers.
  elements: str
  returned: always
  sample:
  - ntp.example.com
  type: list
realm:
  description: The Kerberos realm of the detected or passed in IPA deployment.
  returned: always
  sample: EXAMPLE.COM
  type: str
servers:
  description: The list of detected or passed in IPA servers.
  elements: str
  returned: always
  sample:
  - server1.example.com
  - server2.example.com
  type: list