README.md

client_join_status Role

The client_join_status role creates CSV and HTML reports that show the Active Directory join status of managed hosts.

Requirements

The role requires the Safeguard Authentication Services client software be installed on the client. See client_sw role for how to peform client software installation using Ansible.

Variables

All of the variables shown below have a default value but can be overridden to suit your environment. Variable overriding can be done in playbooks, inventories, from the command line using the -e switch with the ansible-playbook command, or from Ansible Tower and AWX. See Ansbile documentation for further information.

Report generation

Report generation variable defaults for all roles are set by variables in the common role and can be overriden for all roles by setting the appropriate common role variable. See common role report generation variables in the common role.

• client_join_status_reports_generate enables report generation. Reports are generated at the end of a client_join_status run for all hosts.

  Default value is:

  client_join_status_reports_generate: "{{ reports_generate }}"

• client_join_status_reports_backup enables backup of prior reports by renaming them with the date and time they were generated so that the latest reports do not override the previous reports.

  Default value is:

  client_join_status_reports_backup: "{{ reports_backup }}"
  

• client_join_status_reports_host sets the host on which the reports should be generated.

  Default value is:

  client_join_status_reports_host: "{{ reports_host }}"

• client_join_status_reports is a list of dictionaries that define the reports to be generated. The default value creates a CSV and HTML report using the templates included with the client_join_status role.

  Default value is:

  client_join_reports:
    - src:  client_join_status_report.csv.j2
      dest: client_join_status_report.csv
    - src:  client_join_status_report.html.j2
      dest: client_join_status_report.html

  The src key for each list entry is the report template file on the Ansible control node. With a relative path Ansible will look in the client_join_status role template directory. Use a absolute path to speciy templates located elsewhere on the Ansible control node.

  The dest key for each list entry is the report file on the machine specified in client_join_status_reports_host. If client_join_status_reports_host is set to the Ansible control node a relative path can be used and it will be relative to the directory from which the playbook is run. For other hosts, an absolute path must be used. In either case the containing directory must exist.

Plugins

The client_join_status role contains a plugin to support operation of the role:

• get_join_status module checks the machine's Active Directory join status using the Safeguard Authentication Services vastool binary status command.

Usage

Below is a sample playbook using the client_join_status role.

---

- hosts: all
  gather_facts: false

  # The variables you would most likely want/need to override have been included
  vars:

    # Reports
    client_join_status_reports_generate: true
    client_join_status_reports_backup: false

  roles:
    - name: oneidentity.authentication_services.client_join_status

For a copy of this and other sample playbooks see examples