Skip to content

Commit

Permalink
Merge pull request #28 from llnagy76/various_modifications
Browse files Browse the repository at this point in the history
Various modifications
  • Loading branch information
llnagy76 authored Feb 21, 2022
2 parents ba693de + 624a4af commit 7d6ee8a
Show file tree
Hide file tree
Showing 12 changed files with 84 additions and 119 deletions.
52 changes: 30 additions & 22 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,18 +6,16 @@ The One Identity Safeguard Authentication Services Ansible Collection, referred

## Collection Contents

### Implemented

* [`common role`](roles/common/README.md): Common tasks and variables required by other roles.

* [`client_sw role`](roles/client_sw/README.md): Client software install, upgrade, downgrade, uninstall, and version checking.
* [`client_sw_pkgs module`](roles/client_sw/README.md#plugins) Client software install package directory checking.
* [`pkgdict2items filter`](roles/client_sw/README.md#plugins) Client software package sorting by state and name.

* [`client_preflight role`](roles/client_preflight/README.md): Check client readiness for software install and AD join.
* [`preflight module`](roles/client_preflight/README.md#plugins) Performs preflight tasks on host.

* [`client_join role`](roles/client_join/README.md): Client Active Directory joining/unjoining.
* [`client_sw role`](roles/client_sw/README.md): Client software install, upgrade, downgrade, uninstall, and version checking.
* [`client_sw_pkgs module`](roles/client_sw/README.md#plugins) Client software install package directory checking.
* [`pkgdict2items filter`](roles/client_sw/README.md#plugins) Client software package sorting by state and name.

* [`client_join role`](roles/client_join/README.md): Client Active Directory joining/unjoining.
* [`vastool_join module`](roles/client_join/README.md#plugins) Performs Active Directory join/unjoin tasks on host.

* [`client_config role`](roles/client_config/README.md): Client configuration.
Expand All @@ -26,33 +24,41 @@ The One Identity Safeguard Authentication Services Ansible Collection, referred
* [`client_agent_status role`](roles/client_agent_status/README.md): Checks the health status of client agents.
* [`vastool_status module`](roles/client_agent_status/README.md#plugins) Tests the machine's join against Active Directory and local configuration for various issues.

* [`host_access_control role`](roles/host_access_control/README.md): Show the content of users.allow and users.deny files.
* [`get_host_access_control module`](roles/host_access_control/README.md#plugins) Reads and returns data from users.allow and users.deny.

* [`local_unix_users role`](roles/local_unix_users/README.md): Lists all users on all hosts or lists the hosts where a specific user account exists in /etc/passwd.
* [`get_local_unix_users module`](roles/local_unix_users/README.md#plugins) Reads, filters and returns data from /etc/passwd.

* [`local_unix_groups role`](roles/local_unix_groups/README.md): Lists all groups on all hosts or lists the hosts where a specific group exists in /etc/group.
* [`get_local_unix_groups module`](roles/local_unix_groups/README.md#plugins) Reads, filters and returns data from /etc/group.
### Host reports

* [`unix_computers_in_ad role`](roles/unix_computers_in_ad/README.md): Lists all Unix computers in Active Directory in the requested scope.

### User reports

* [`ad_user_conflicts role`](roles/ad_user_conflicts/README.md): Lists all users with Unix User ID numbers (UID numbers) assigned to other Unix-enabled user account.

* [`local_unix_user_conflicts role`](roles/local_unix_user_conflicts/README.md): Identifies local user accounts that would conflict with a specified user name and UID on other hosts.

* [`local_unix_users_with_ad_logon`](roles/local_unix_users_with_ad_logon/README.md): Identifies the local user accounts that are required to use Active Directory credentials to log onto the Unix hosts.
* [`local_unix_users role`](roles/local_unix_users/README.md): Lists all users on all hosts or lists the hosts where a specific user account exists in /etc/passwd.
* [`get_local_unix_users module`](roles/local_unix_users/README.md#plugins) Reads, filters and returns data from /etc/passwd.

* [`local_unix_users_with_ad_logon role`](roles/local_unix_users_with_ad_logon/README.md): Identifies the local user accounts that are required to use Active Directory credentials to log onto the Unix hosts.

* [`unix_enabled_ad_users role`](roles/unix_enabled_ad_users/README.md): Lists all Active Directory users that have Unix user attributes.

* [`unix_enabled_ad_groups role`](roles/unix_enabled_ad_groups/README.md): Lists all Active Directory groups that have Unix group attributes.
### Group reports

* [`ad_group_conflicts role`](roles/ad_group_conflicts/README.md): Lists all Active Directory groups with Unix Group ID (GID) numbers assigned to other Unix-enabled groups.

* [`local_unix_groups role`](roles/local_unix_groups/README.md): Lists all groups on all hosts or lists the hosts where a specific group exists in /etc/group.
* [`get_local_unix_groups module`](roles/local_unix_groups/README.md#plugins) Reads, filters and returns data from /etc/group.

* [`unix_enabled_ad_groups role`](roles/unix_enabled_ad_groups/README.md): Lists all Active Directory groups that have Unix group attributes.

### Access & Privileges reports

* [`logon_policy_for_unix_host role`](roles/logon_policy_for_unix_host/README.md): Identifies the Active Directory users that have been explicitly granted log on permissions for the Unix hosts.

* [`logon_policy_for_ad_user role`](roles/logon_policy_for_ad_user/README.md): Identifies the hosts where Active Directory users have been granted log on permission.

* [`host_access_control role`](roles/host_access_control/README.md): Show the content of users.allow and users.deny files.
* [`get_host_access_control module`](roles/host_access_control/README.md#plugins) Reads and returns data from users.allow and users.deny.

## Installation

### Prerequisites
Expand All @@ -61,6 +67,8 @@ The One Identity Safeguard Authentication Services Ansible Collection, referred

* `Collections are a new feature introduced in Ansible version 2.9. Please use the latest 2.9+ release for the best user experience.`

* [Jinja](https://github.com/pallets/jinja) version 2.10 or later.

* One Identity [Safeguard Authentication Services](https://www.oneidentity.com/products/authentication-services/) version 4.2.x or later

* `This collection expects the components and structure of Safeguard Authentication Services 4.2.x or later.`
Expand Down Expand Up @@ -98,14 +106,14 @@ To install from [GitHub](https://github.com/OneIdentity/ansible-authentication-s

Using `ansible-galaxy` command:
```bash
ansible-galaxy collection install https://github.com/OneIdentity/ansible-authentication-services/releases/download/v0.0.8/oneidentity-authentication_services-0.0.8.tar.gz
ansible-galaxy collection install https://github.com/OneIdentity/ansible-authentication-services/releases/download/v0.1.0/oneidentity-authentication_services-0.1.0.tar.gz
```

The collection can also be added to a project's `requirements.yml` file
```yaml
---
collections:
- name: https://github.com/OneIdentity/ansible-authentication-services/releases/download/v0.0.8/oneidentity-authentication_services-0.0.8.tar.gz
- name: https://github.com/OneIdentity/ansible-authentication-services/releases/download/v0.1.0/oneidentity-authentication_services-0.1.0.tar.gz
```

and installed using the `ansible-galaxy` command. This method allows all required collections for a project to be specified in one place and installed with one command.
Expand Down Expand Up @@ -135,7 +143,7 @@ For local build and installation, you can clone the Git repository, build the co
The build command will generate an Ansible Galaxy collection artifact with a `tar.gz` file extension, sample output will look like the following:

```
Created collection for oneidentity.authentication_services at /home/user/ansible-authentication-services/oneidentity-authentication_services-0.0.8.tar.gz
Created collection for oneidentity.authentication_services at /home/user/ansible-authentication-services/oneidentity-authentication_services-0.1.0.tar.gz
```

`Pleae note the path shown above is just an example, the path to your build artifact will be in the root directory of the cloned repository.`
Expand All @@ -145,14 +153,14 @@ For local build and installation, you can clone the Git repository, build the co
Using `ansible-galaxy` command:

```bash
ansible-galaxy collection install /home/user/ansible-authentication-services/oneidentity-authentication_services-0.0.8.tar.gz
ansible-galaxy collection install /home/user/ansible-authentication-services/oneidentity-authentication_services-0.1.0.tar.gz
```

The collection can also be added to a project's `requirements.yml` file
```yaml
---
collections:
- name: /home/user/ansible-authentication-services/oneidentity-authentication_services-0.0.8.tar.gz
- name: /home/user/ansible-authentication-services/oneidentity-authentication_services-0.1.0.tar.gz
```

and installed using the `ansible-galaxy` command. This method allows all required collections for a project to be specified in one place and installed with one command.
Expand Down
82 changes: 46 additions & 36 deletions examples/README.md
Original file line number Diff line number Diff line change
@@ -1,76 +1,86 @@
# Examples

A small collection of sample files has been included to help get you started.
A small collection of sample files has been included to help get you started. The variables most likely to be overriden have been included in this playbook for your convenience even though many are still set to their default values.

## Inventory Examples
# Inventory Examples

[Simple](inventory_simple.yml) and [complex](inventory_complex.yml) inventory files have been included. There are many ways besides YAML files to pass inventory information to Ansible, see [Ansible documentation](https://docs.ansible.com/ansible/latest/user_guide/intro_inventory.html) for further information.

## `client_preflight` Role Example
# Role Examples

The [`client_preflight`](run_client_preflight.yml) role example shows use of the `client_preflight` role in an Ansbile playbook. The variables most likely to be overriden have been included in this playbook for your convenience even though many are still set to their default values.
### `client_preflight` Role Example

## `client_sw` Role Example
The [`client_preflight`](run_client_preflight.yml) role example shows use of the `client_preflight` role in an Ansible playbook.

The [`client_sw`](run_client_sw.yml) role example shows use of the `client_sw` role in an Ansbile playbook. The variables most likely to be overriden have been included in this playbook for your convenience even though many are still set to their default values.
### `client_sw` Role Example

## `client_join` Role Example
The [`client_sw`](run_client_sw.yml) role example shows use of the `client_sw` role in an Ansible playbook.

The [`client_join`](run_client_join.yml) role example shows use of the `client_join` role in an Ansbile playbook. The variables most likely to be overriden have been included in this playbook for your convenience even though many are still set to their default values.
### `client_join` Role Example

## `client_config` Role Example
The [`client_join`](run_client_join.yml) role example shows use of the `client_join` role in an Ansible playbook.

The [`client_config`](run_client_config.yml) role example shows use of the `client_config` role in an Ansbile playbook. The variables most likely to be overriden have been included in this playbook for your convenience even though many are still set to their default values.
### `client_config` Role Example

## `client_agent_status` Role Example
The [`client_config`](run_client_config.yml) role example shows use of the `client_config` role in an Ansible playbook.

The [`client_agent_status`](run_client_agent_status.yml) role example shows use of the `client_agent_status` role in an Ansbile playbook. The variables most likely to be overriden have been included in this playbook for your convenience even though many are still set to their default values.
### `client_agent_status` Role Example

## `host_access_control` Role Example
The [`client_agent_status`](run_client_agent_status.yml) role example shows use of the `client_agent_status` role in an Ansible playbook.

The [`host_access_control`](run_host_access_control.yml) role example shows use of the `host_access_control` role in an Ansbile playbook. The variables most likely to be overriden have been included in this playbook for your convenience even though many are still set to their default values.
## Host reports

## `local_unix_users` Role Example
### `unix_computers_in_ad` Role Example

The [`local_unix_users`](run_local_unix_users.yml) role example shows use of the `local_unix_users` role in an Ansbile playbook. The variables most likely to be overriden have been included in this playbook for your convenience even though many are still set to their default values.
The [`unix_computers_in_ad`](run_unix_computers_in_ad.yml) role example shows use of the `unix_computers_in_ad` role in an Ansible playbook.

## `local_unix_groups` Role Example
## User reports

The [`local_unix_groups`](run_local_unix_groups.yml) role example shows use of the `local_unix_groups` role in an Ansbile playbook. The variables most likely to be overriden have been included in this playbook for your convenience even though many are still set to their default values.
### `ad_user_conflicts` Role Example

## `unix_computers_in_ad` Role Example
The [`ad_user_conflicts`](run_ad_user_conflicts.yml) role example shows use of the `ad_user_conflicts` role in an Ansible playbook.

The [`unix_computers_in_ad`](run_unix_computers_in_ad.yml) role example shows use of the `unix_computers_in_ad` role in an Ansbile playbook. The variables most likely to be overriden have been included in this playbook for your convenience even though many are still set to their default values.
### `local_unix_user_conflicts` Role Example

## `ad_user_conflicts` Role Example
The [`local_unix_user_conflicts`](run_local_unix_user_conflicts.yml) role example shows use of the `local_unix_user_conflicts` role in an Ansible playbook.

The [`ad_user_conflicts`](run_ad_user_conflicts.yml) role example shows use of the `ad_user_conflicts` role in an Ansbile playbook. The variables most likely to be overriden have been included in this playbook for your convenience even though many are still set to their default values.
### `local_unix_users` Role Example

## `local_unix_user_conflicts` Role Example
The [`local_unix_users`](run_local_unix_users.yml) role example shows use of the `local_unix_users` role in an Ansible playbook.

The [`local_unix_user_conflicts`](run_local_unix_user_conflicts.yml) role example shows use of the `local_unix_user_conflicts` role in an Ansbile playbook. The variables most likely to be overriden have been included in this playbook for your convenience even though many are still set to their default values.
### `local_unix_users_with_ad_logon` Role Example

## `local_unix_users_with_ad_logon` Role Example
The [`local_unix_users_with_ad_logon`](run_local_unix_users_with_ad_logon.yml) role example shows use of the `local_unix_users_with_ad_logon` role in an Ansible playbook.

The [`local_unix_users_with_ad_logon`](run_local_unix_users_with_ad_logon.yml) role example shows use of the `local_unix_users_with_ad_logon` role in an Ansbile playbook. The variables most likely to be overriden have been included in this playbook for your convenience even though many are still set to their default values.
### `unix_enabled_ad_users` Role Example

## `unix_enabled_ad_users` Role Example
The [`unix_enabled_ad_users`](run_unix_enabled_ad_users.yml) role example shows use of the `unix_enabled_ad_users` role in an Ansible playbook.

The [`unix_enabled_ad_users`](run_unix_enabled_ad_users.yml) role example shows use of the `unix_enabled_ad_users` role in an Ansbile playbook. The variables most likely to be overriden have been included in this playbook for your convenience even though many are still set to their default values.
## Group reports

## `unix_enabled_ad_groups` Role Example
### `ad_group_conflicts` Role Example

The [`unix_enabled_ad_groups`](run_unix_enabled_ad_groups.yml) role example shows use of the `unix_enabled_ad_groups` role in an Ansbile playbook. The variables most likely to be overriden have been included in this playbook for your convenience even though many are still set to their default values.
The [`ad_group_conflicts`](run_ad_group_conflicts.yml) role example shows use of the `ad_group_conflicts` role in an Ansible playbook.

## `ad_group_conflicts` Role Example
### `local_unix_groups` Role Example

The [`ad_group_conflicts`](run_ad_group_conflicts.yml) role example shows use of the `ad_group_conflicts` role in an Ansbile playbook. The variables most likely to be overriden have been included in this playbook for your convenience even though many are still set to their default values.
The [`local_unix_groups`](run_local_unix_groups.yml) role example shows use of the `local_unix_groups` role in an Ansible playbook.

## `logon_policy_for_unix_host` Role Example
### `unix_enabled_ad_groups` Role Example

The [`logon_policy_for_unix_host`](run_logon_policy_for_unix_host.yml) role example shows use of the `logon_policy_for_unix_host` role in an Ansbile playbook. The variables most likely to be overriden have been included in this playbook for your convenience even though many are still set to their default values.
The [`unix_enabled_ad_groups`](run_unix_enabled_ad_groups.yml) role example shows use of the `unix_enabled_ad_groups` role in an Ansible playbook.

## `logon_policy_for_ad_user` Role Example
## Access & Privileges reports

The [`logon_policy_for_ad_user`](run_logon_policy_for_ad_user.yml) role example shows use of the `logon_policy_for_ad_user` role in an Ansbile playbook. The variables most likely to be overriden have been included in this playbook for your convenience even though many are still set to their default values.
### `logon_policy_for_unix_host` Role Example

The [`logon_policy_for_unix_host`](run_logon_policy_for_unix_host.yml) role example shows use of the `logon_policy_for_unix_host` role in an Ansible playbook.

### `logon_policy_for_ad_user` Role Example

The [`logon_policy_for_ad_user`](run_logon_policy_for_ad_user.yml) role example shows use of the `logon_policy_for_ad_user` role in an Ansible playbook.

### `host_access_control` Role Example

The [`host_access_control`](run_host_access_control.yml) role example shows use of the `host_access_control` role in an Ansible playbook.

2 changes: 1 addition & 1 deletion galaxy.yml
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ namespace: oneidentity
name: authentication_services

# Semantic versioning compliant version designation
version: "0.0.8"
version: "0.1.0"

# The path do the Markdown(.md) readme file
readme: README.md
Expand Down
Loading

0 comments on commit 7d6ee8a

Please sign in to comment.