oneidentity.authentication_services.vastool_join (0.3.1) — module

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 join/unjoin using the Authentication Services vastool binary.

Usage examples

Scanned by Steampunk Spotter

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

- name: Simple join
  vastool_join:
    state: joined
    domain: oneidentity.com
    username: user
    password: pass
  register: vastool_join_result

Scanned by Steampunk Spotter

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

- name: Simple unjoin
  vastool_join:
    state: unjoined
    domain: oneidentity.com
    username: user
    password: pass
  register: vastool_join_result

Inputs

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

state:
    choices:
    - joined
    - unjoined
    default: joined
    description:
    - Active Directory join state
    required: false
    type: str

domain:
    description:
    - Active Directory domain to join
    required: true
    type: str

keytab:
    default: ''
    description:
    - Full path and filename of Kerberos 5 keytab to authenticate
    required: false
    type: str

servers:
    default: []
    description:
    - Servers to use for join
    elements: str
    required: false
    type: list

password:
    default: ''
    description:
    - Active Directory password to authenticate
    required: false
    type: str

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

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

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

account_name:
    default: fully-qualified DNS name of host
    description:
    - Name of host computer account
    required: false
    type: str

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

account_container:
    default: default computers container
    description:
    - Name of container for host computer account
    required: false
    type: str

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: Vastool join/unjoin steps and results of those steps
      returned: when facts_verbose true
      type: list of dicts
    version:
      description: Version of vastool
      returned: always
      type: str
  returned: when facts parameter is true
  type: dict