From 37375df3e31f76de34a1c5a06dbbb95fe58dc9e6 Mon Sep 17 00:00:00 2001 From: Simon Baerlocher Date: Wed, 15 Jan 2020 13:02:36 +0100 Subject: [PATCH 1/6] inital documentation --- .nojekyll | 0 CHANGELOG.md | 10 +++ docs/index.html | 112 +++++++++++++++++++++------ galaxy.yml | 6 +- roles/directories/README.md | 39 ++++++++++ roles/disks/README.md | 28 +++++++ roles/local_administrators/README.md | 54 +++++++++++++ roles/membership/README.md | 65 ++++++++++++++++ roles/onedrive/README.md | 31 ++++++++ roles/remote_desktop/README.md | 71 +++++++++++++++++ roles/wsl/README.md | 25 ++++++ 11 files changed, 415 insertions(+), 26 deletions(-) create mode 100644 .nojekyll create mode 100644 CHANGELOG.md create mode 100644 roles/directories/README.md create mode 100644 roles/disks/README.md create mode 100644 roles/local_administrators/README.md create mode 100644 roles/membership/README.md create mode 100644 roles/onedrive/README.md create mode 100644 roles/remote_desktop/README.md create mode 100644 roles/wsl/README.md diff --git a/.nojekyll b/.nojekyll new file mode 100644 index 0000000..e69de29 diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..4b44963 --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,10 @@ +# Changelog + +This project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html) +and [human-readable changelog](https://keepachangelog.com/en/1.0.0/). + +## master + +### Added + +- Initial docs diff --git a/docs/index.html b/docs/index.html index 1961381..0fa2951 100644 --- a/docs/index.html +++ b/docs/index.html @@ -1,23 +1,89 @@ - - - - - - My Docs - - - - -
- - - - + + + + + + My Docs + + + + +
+ + + + diff --git a/galaxy.yml b/galaxy.yml index d92e3bc..09b8775 100644 --- a/galaxy.yml +++ b/galaxy.yml @@ -17,12 +17,12 @@ readme: README.md # A list of the collection's content authors. Can be just the name or in the format 'Full Name (url) # @nicks:irc/im.site#channel' authors: - - 'Simon Bärlocher (https://sbaerlocher.ch)' + - 'Simon Baerlocher (https://sbaerlocher.ch)' ### OPTIONAL but strongly recommended # A short summary description of the collection -description: 'Collection of Virtualization Software for Linux: VirtualBox, KVM, VMware, Docker-CE, Podman' +description: 'Ansible Collection for Windows functions.' # Either a single license or a list of licenses for content inside of a collection. Ansible Galaxy currently only # accepts L(SPDX,https://spdx.org/licenses/) licenses. This key is mutually exclusive with 'license_file' license: @@ -30,7 +30,7 @@ license: # The path to the license file for the collection. This path is relative to the root of the collection. This key is # mutually exclusive with 'license' -license_file: '' +license_file: 'LICENSE' # A list of tags you want to associate with the collection for indexing/searching. A tag name has the same character # requirements as 'namespace' and 'name' diff --git a/roles/directories/README.md b/roles/directories/README.md new file mode 100644 index 0000000..081e4fc --- /dev/null +++ b/roles/directories/README.md @@ -0,0 +1,39 @@ +# Ansible Role: directories + +## Description + +Creates various directory structures on the target system. + +## Role Variables + +### directories + +With directories you can specify a list of directories with subdirectories to be created on the target system. + +```yml +directories: + - main: "{{ ansible_env.SystemDrive }}\\{{ directories_main }}" + subdirectories: + - 'facts.d' + - 'xml.d' + - 'tools.d' + - 'ansible' +``` + +### directories_main [Optional] + +Optional root directory to be created. + +```yml +directories_main: Support +``` + +## Example Playbook + +```yml +- hosts: all + collections: + - sbaerlocher.windows + roles: + - directories +``` diff --git a/roles/disks/README.md b/roles/disks/README.md new file mode 100644 index 0000000..4bb04e1 --- /dev/null +++ b/roles/disks/README.md @@ -0,0 +1,28 @@ +# Ansible Role: disks + +## Description + +Initializes, formats and mounts an additional disk on the target system. + +## Role Variables + +### disks + +A list of all devices to be included on the target system. + +```yml +disks: + - disk_number: 1 + drive_letter: D + new_label: Data +``` + +## Example Playbook + +```yml +- hosts: all + collections: + - sbaerlocher.windows + roles: + - directories +``` diff --git a/roles/local_administrators/README.md b/roles/local_administrators/README.md new file mode 100644 index 0000000..ee0d5b9 --- /dev/null +++ b/roles/local_administrators/README.md @@ -0,0 +1,54 @@ +# Ansible Role: local_administrators + +## Description + +Ansible role that adds and removes users and groups to the Local Administraotren group. + +## Role Variables + +### local administrators list + +A list of users or groups that Local Administrators +should have rights to on the device. + +```yml +local_administrators_defaults: [] +local_administrators_groups: [] +local_administrators_hosts: [] +``` + +#### example local administrators list + +```yml +local_administrators_defaults: + - UserX + - GroupX +``` + +### Pure Option + +If the state is enable, only the specified elements exist, +and all other unspecified existing elements are removed. + +```yml +local_administrators_pure_enable: false +``` + +### local administrators group + +Name of the local administrators group like e.g. +English Administrators or German Administratoren + +```yml +local_administrators_group: Administrators +``` + +## Example Playbook + +```yml +- hosts: all + collections: + - sbaerlocher.windows + roles: + - local_administrators +``` diff --git a/roles/membership/README.md b/roles/membership/README.md new file mode 100644 index 0000000..e936be3 --- /dev/null +++ b/roles/membership/README.md @@ -0,0 +1,65 @@ +# Ansible Role: membership + +## Description + +Adds the target device to a domain or to a workgroup. + +## Role Variables + +### membership_domain_name + +the DNS name of the domain to which the targeted Windows host should be joined. + +```yml +# membership_domain_name: '' +``` + +### membership_admin_user + +Username of a domain admin for the target domain (required to join or leave the domain). + +```yml +membership_admin_user: '' +``` + +### membership_admin_password + +Password for the specified domain_admin_user. + +```yml +membership_admin_password: '' +``` + +### membership_ou + +The desired OU path for adding the computer object. default: omit + +```yml +membership_ou: '{{ omit }}' +``` + +### membership_state + +Whether the target host should be a member of a domain or workgroup. + +```yml +membership_state: 'domain' +``` + +### membership_workgroup_name + +When state is workgroup, the name of the workgroup that the Windows host should be in. + +```yml +# membership_workgroup_name: '' +``` + +## Example Playbook + +```yml +- hosts: all + collections: + - sbaerlocher.windows + roles: + - membership +``` diff --git a/roles/onedrive/README.md b/roles/onedrive/README.md new file mode 100644 index 0000000..a71848b --- /dev/null +++ b/roles/onedrive/README.md @@ -0,0 +1,31 @@ +# Ansible Role: onedrive + +## Description + +Disables or removes Microsoft OneDrive on a Windows 10 device. + +## Role Variables + +## onedrive_disable + +Disables OneDrive in the registry + +```yml +onedrive_disable: true +``` + +## onedrive_remove + +Uninstalls OneDrive on the device. + +```yml +onedrive_remove: false +``` + +## Example Playbook + +```yml +- hosts: all + roles: + - sbaerlocher.windows.onedrive +``` diff --git a/roles/remote_desktop/README.md b/roles/remote_desktop/README.md new file mode 100644 index 0000000..1a60ec7 --- /dev/null +++ b/roles/remote_desktop/README.md @@ -0,0 +1,71 @@ +# Ansible Role: remote-desktop + +## Description + +Enables Windows Remote Desktop Services on Windows. + +## Role Variables + +### remote_desktop_enabled + +Turns the Remote Desktop Service on or off. + +```yml +remote_desktop_enabled: false +``` + +### remote_desktop_minencryptionLevel + +Determines the encryption level of the remote desktop connection. More on: [![getadmx doc](https://img.shields.io/badge/getadmx-doc-blue.svg)](https://getadmx.com/?Category=Windows_10_2016&Policy=Microsoft.Policies.TerminalServer::TS_ENCRYPTION_POLICY) + +```yml +remote_desktop_minencryptionLevel: '3' +``` + +### remote_desktop_port + +Determines on which port the Remote Desktop Service should be started. + +```yml +remote_desktop_port: 3389 +``` + +### remote_desktop_shutdown_disable + +Disables the function that can be shut down from a remote desktop. + +```yml +remote_desktop_shutdown_disable: false +``` + +### remote_desktop_securitylayer + +Determines the security level of the remote desktop connection. More on: [![getadmx doc](https://img.shields.io/badge/getadmx-doc-blue.svg)](https://getadmx.com/?Category=Windows_10_2016&Policy=Microsoft.Policies.TerminalServer::TS_SECURITY_LAYER_POLICY) + +```yml +remote_desktop_securitylayer: '1' +``` + +### remote_desktop_group + +Group for logging on to the Remote Desktop Service. + +```yml +remote_desktop_group: 'Remotedesktopbenutzer' +``` + +### remote_desktop_members + +Users or groups who are allowed to log on to the Remote Desktop. + +```yml +remote_desktop_members: [] +``` + +## Example Playbook + +```yml +- hosts: all + roles: + - sbaerlocher.remote-desktop +``` diff --git a/roles/wsl/README.md b/roles/wsl/README.md new file mode 100644 index 0000000..cf55206 --- /dev/null +++ b/roles/wsl/README.md @@ -0,0 +1,25 @@ +# Ansible Role: wsl + +## Description + +The role activates the windows wsl feature on a windows device. + +## Role Variables + +### wsl_enbale + +Switches the Windows Subsystem for Linux on or off. + +```yml +wsl_enbale: false +``` + +## Example Playbook + +```yml +- hosts: all + collections: + - sbaerlocher.windows + roles: + - wsl +``` From 535db35a48b1c98124815bbdeb262b7d9d02848e Mon Sep 17 00:00:00 2001 From: Pascal Mages Date: Mon, 20 Jan 2020 10:28:05 +0100 Subject: [PATCH 2/6] Update README.md improved wording --- roles/directories/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/roles/directories/README.md b/roles/directories/README.md index 081e4fc..1d12233 100644 --- a/roles/directories/README.md +++ b/roles/directories/README.md @@ -2,7 +2,7 @@ ## Description -Creates various directory structures on the target system. +Creates a directory structure on the target system. ## Role Variables From a26c919213da844ba3bafd5df82da19cfc06b478 Mon Sep 17 00:00:00 2001 From: Pascal Mages Date: Mon, 20 Jan 2020 10:34:03 +0100 Subject: [PATCH 3/6] Update README.md improved wording --- roles/local_administrators/README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/roles/local_administrators/README.md b/roles/local_administrators/README.md index ee0d5b9..4112073 100644 --- a/roles/local_administrators/README.md +++ b/roles/local_administrators/README.md @@ -2,7 +2,7 @@ ## Description -Ansible role that adds and removes users and groups to the Local Administraotren group. +Ansible role that adds and removes users and groups to the Local Administrators group. ## Role Variables @@ -27,7 +27,7 @@ local_administrators_defaults: ### Pure Option -If the state is enable, only the specified elements exist, +If the state is enabled, only the specified elements will persist, and all other unspecified existing elements are removed. ```yml From 4fa8ba75091b8da780653f3d903b414b946ae212 Mon Sep 17 00:00:00 2001 From: Pascal Mages Date: Mon, 20 Jan 2020 10:34:46 +0100 Subject: [PATCH 4/6] Update README.md fix roles in example playbook --- roles/disks/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/roles/disks/README.md b/roles/disks/README.md index 4bb04e1..7f0b237 100644 --- a/roles/disks/README.md +++ b/roles/disks/README.md @@ -24,5 +24,5 @@ disks: collections: - sbaerlocher.windows roles: - - directories + - disks ``` From b81b255ead2a0565763f7f42efb8ba3251f9188c Mon Sep 17 00:00:00 2001 From: Pascal Mages Date: Mon, 20 Jan 2020 10:38:24 +0100 Subject: [PATCH 5/6] Update README.md improved wording --- roles/remote_desktop/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/roles/remote_desktop/README.md b/roles/remote_desktop/README.md index 1a60ec7..cb82db1 100644 --- a/roles/remote_desktop/README.md +++ b/roles/remote_desktop/README.md @@ -32,7 +32,7 @@ remote_desktop_port: 3389 ### remote_desktop_shutdown_disable -Disables the function that can be shut down from a remote desktop. +Disables the the shutdown option from a remote desktop. ```yml remote_desktop_shutdown_disable: false From c6e2b102374e8f3eff28b7ba78bb2b6fa454b9b7 Mon Sep 17 00:00:00 2001 From: Pascal Mages Date: Mon, 20 Jan 2020 10:41:27 +0100 Subject: [PATCH 6/6] Update README.md improve wording --- roles/wsl/README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/roles/wsl/README.md b/roles/wsl/README.md index cf55206..a13c8a2 100644 --- a/roles/wsl/README.md +++ b/roles/wsl/README.md @@ -2,13 +2,13 @@ ## Description -The role activates the windows wsl feature on a windows device. +The role activates the Windows Subsystem for Linux (WSL) feature on a windows device. ## Role Variables -### wsl_enbale +### wsl_enable -Switches the Windows Subsystem for Linux on or off. +Switches the WSL on or off. ```yml wsl_enbale: false