oneidentity.authentication_services.preflight (0.3.1) — module

Active Directory pre-join checking

| "added in version" 2.9 of oneidentity.authentication_services"

Authors: Mark Stillings (mark.stillings@oneidentity.com)

preview | supported by community

Install collection

Install with ansible-galaxy collection install oneidentity.authentication_services:==0.3.1


Add to requirements.yml

  collections:
    - name: oneidentity.authentication_services
      version: 0.3.1

Description

Performs Active Directory pre-join checking by using the Authentication Services preflight binary.

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Normal usage
  preflight:
    domain: oneidentity.com
    username: user
    password: pass
  register: preflight_result

Inputs

    
path:
    default: /opt/quest/bin/preflight
    description:
    - Path to preflight binary
    required: false
    type: str

facts:
    default: true
    description:
    - Generate Ansible facts?
    required: false
    type: bool

domain:
    description:
    - Active Directory domain to run checks against
    required: true
    type: str

servers:
    default: []
    description:
    - Domain controllers to run checks against
    elements: str
    required: false
    type: list

timeout:
    default: 5
    description:
    - Timeout for port checks in seconds
    required: false
    type: int

password:
    description:
    - Active Directory password to authenticate
    required: true
    type: str

timesync:
    default: false
    description:
    - Perform timesync if needed
    required: false
    type: bool

username:
    description:
    - Active Directory user or principal to perform checks
    required: true
    type: str

facts_key:
    default: preflight
    description:
    - Ansible facts key
    required: false
    type: str

extra_args:
    default: ''
    description:
    - Other arguments to be passed on to preflight
    required: false
    type: str

facts_verbose:
    default: true
    description:
    - Verbose Ansible facts?
    required: false
    type: bool

Outputs

ansible_facts:
  description: All non-standard return values are placed in Ansible facts
  keys:
    changed:
      description: Did the state of the host change?
      returned: always
      type: bool
    failed:
      description: Did the module fail?
      returned: always
      type: bool
    msg:
      description: Additional information if failed
      returned: always
      type: str
    params:
      description: Parameters passed in
      returned: always
      type: dict
    steps:
      description: The preflight checks and results of those checks
      returned: when facts_verbose true
      type: list of dicts
    version:
      description: Version of preflight
      returned: always
      type: str
  returned: when facts parameter is true
  type: dict