freeipa.ansible_freeipa.ipaclient_get_otp (1.8.4) — module

Install collection

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

Add to requirements.yml

  collections:
    - name: freeipa.ansible_freeipa
      version: 1.8.4

Description

Manage hosts in a IPA domain. The operation needs to be authenticated with Kerberos either by providing a password or a keytab corresponding to a principal allowed to perform host operations.

Usage examples

Scanned by Steampunk Spotter

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

# Example from Ansible Playbooks
# Add a new host with a random OTP, authenticate using principal/password
- freeipa.ansible_freeipa.ipaclient_get_otp:
    principal: admin
    password: MySecretPassword
    fqdn: ipaclient.ipa.domain.com
    ipaddress: 192.168.100.23
    random: True
  register: result_ipaclient_get_otp

Inputs

    
fqdn:
    description: The fully-qualified hostname of the host to add/modify/remove
    required: false

state:
    description: The desired host state
    required: true

ccache:
    description: The local ccache
    required: true

random:
    description: Generate a random password to be used in bulk enrollment
    required: true

ipaddress:
    description: The IP address for the host
    required: true

principal:
    description: User Principal allowed to promote replicas and join IPA realm
    required: true

sshpubkey:
    description: The SSH public key for the host
    required: true

certificates:
    description: A list of host certificates
    required: true

Outputs

host:
  contains:
    certificates:
      description: the list of host certificates
      returned: when present
      type: list
    dn:
      description: the DN of the host entry
      returned: always
      type: string
    fqdn:
      description: the fully qualified host name
      returned: always
      type: string
    has_keytab:
      description: whether the host entry contains a keytab
      returned: always
      type: bool
    has_password:
      description: whether the host entry contains a password
      returned: always
      type: bool
    ipaddress:
      description: the IP address for the host
      returned: when present
      type: string
    managedby_host:
      description: the list of hosts managing the host
      returned: always
      type: list
    randompassword:
      description: the OneTimePassword generated for this host
      returned: changed
      type: string
    sshpubkey:
      description: the SSH public key for the host
      returned: when present
      type: string
  description: the host structure as returned from IPA API
  returned: always
  type: complex