community.general/lib/ansible/modules/windows
John R Barker a23c95023b
Module deprecation: docs, scheme and tests (#34100)
Enforce module deprecation.
After module has reached the end of it's deprecation cycle we will replace it with a docs stub.

* Replace deprecated modules with docs-only sub
* Use of deprecated past deprecation cycle gives meaningful message (see examples below)
* Enforce documentation.deprecation dict via `schema.py`
* Update `ansible-doc` and web docs to display documentation.deprecation
* Document that structure in `dev_guide`
* Ensure that all modules starting with `_` have a `deprecation:` block
* Ensure `deprecation:` block is only used on modules that start with `_`
* `removed_in` A string which represents when this module needs **deleting**
* CHANGELOG.md and porting_guide_2.5.rst list removed modules as well as alternatives
* CHANGELOG.md links to porting guide index

To ensure that meaningful messages are given to the user if they try to use a module at the end of it's deprecation cycle we enforce the module to contain:
```python
if __name__ == '__main__':
    removed_module()
```
2018-01-30 12:23:52 +00:00
..
__init__.py package files 2016-12-08 11:22:22 -05:00
_win_msi.ps1 win_msi: deprecated in favour of win_package (#28741) 2017-08-28 19:53:28 -04:00
_win_msi.py Module deprecation: docs, scheme and tests (#34100) 2018-01-30 12:23:52 +00:00
async_status.ps1 Windows async module support (#4710) 2016-12-08 11:25:02 -05:00
setup.ps1 implement gather_subset on Windows setup (#35212) 2018-01-22 21:10:25 -08:00
slurp.ps1 win_slurp: Small cleanup (#21363) 2017-02-23 22:38:17 -08:00
win_acl.ps1 fix #Requires to be valid in real Powershell (#31858) 2017-10-23 11:40:54 -07:00
win_acl.py Fix SID Lookup Issues on Assorted Windows Modules (#28979) 2017-09-11 07:34:51 +10:00
win_acl_inheritance.ps1 win_acl_inheritance: Added tests and formatting improvements (#25382) 2017-06-19 17:47:35 +01:00
win_acl_inheritance.py Update metadata to 1.1 2017-08-15 23:12:08 -07:00
win_audit_policy_system.ps1 new windows module win_audit_policy_system (#31046) 2017-12-04 17:42:36 -05:00
win_audit_policy_system.py new windows module win_audit_policy_system (#31046) 2017-12-04 17:42:36 -05:00
win_audit_rule.ps1 fix #Requires to be valid in real Powershell (#31858) 2017-10-23 11:40:54 -07:00
win_audit_rule.py new windows module, win_audit_rule (#30473) 2017-10-20 11:20:33 +10:00
win_certificate_store.ps1 win_certificate_store: added new module (#33980) 2018-01-09 05:44:24 +10:00
win_certificate_store.py win_certificate_store: added new module (#33980) 2018-01-09 05:44:24 +10:00
win_chocolatey.ps1 Remove toLower on source (#31983) 2017-10-23 07:18:00 +10:00
win_chocolatey.py win_chocolately document improvedments, mention win_hotfix and use of become (#31085) 2017-09-29 05:47:38 -04:00
win_command.ps1 standardise the powershell FileUtils (#34969) 2018-01-17 14:16:34 +10:00
win_command.py win_command win_shell: add stdin option (#31619) 2017-10-23 09:50:19 +10:00
win_copy.ps1 fixed: win_copy: typo "file file" (double "file") (#33620) 2017-12-07 00:42:39 +01:00
win_copy.py win_copy: added decrypt option (#31291) 2017-10-10 08:21:25 +10:00
win_defrag.ps1 Fix typos 2017-11-07 17:45:07 +01:00
win_defrag.py win_defrag: Fixes to documentation (#32634) 2017-11-07 16:35:54 +01:00
win_disk_facts.ps1 win_disk_facts: Prefix facts with ansible_ and use raw values (#35326) 2018-01-26 19:46:53 +10:00
win_disk_facts.py win_disk_facts: Prefix facts with ansible_ and use raw values (#35326) 2018-01-26 19:46:53 +10:00
win_disk_image.ps1 initial commit of win_disk_image (#22175) 2017-03-01 16:31:01 -08:00
win_disk_image.py Update metadata to 1.1 2017-08-15 23:12:08 -07:00
win_dns_client.ps1 Fixes issue #34956 (#35149) 2018-01-23 10:25:08 +10:00
win_dns_client.py Update metadata to 1.1 2017-08-15 23:12:08 -07:00
win_domain.ps1 win_domain: added option to set database and sysvol path (#34333) 2018-01-04 06:32:01 +10:00
win_domain.py win_domain: added option to set database and sysvol path (#34333) 2018-01-04 06:32:01 +10:00
win_domain_controller.ps1 win_domain_controller: add readonly support (#33850) 2018-01-04 08:46:32 +10:00
win_domain_controller.py win_domain_controller: add readonly support (#33850) 2018-01-04 08:46:32 +10:00
win_domain_group.ps1 win_domain_user: added ability to explicitly set credentials and user when interacting with AD (#34562) 2018-01-08 09:38:13 +10:00
win_domain_group.py win_domain_user: added ability to explicitly set credentials and user when interacting with AD (#34562) 2018-01-08 09:38:13 +10:00
win_domain_membership.ps1 win_domain_membership: added better error handling and basic tests (#30674) 2017-09-22 05:59:42 +10:00
win_domain_membership.py Update metadata to 1.1 2017-08-15 23:12:08 -07:00
win_domain_user.ps1 win_domain_user: added ability to explicitly set credentials and user when interacting with AD (#34562) 2018-01-08 09:38:13 +10:00
win_domain_user.py win_domain_user: added ability to explicitly set credentials and user when interacting with AD (#34562) 2018-01-08 09:38:13 +10:00
win_dotnet_ngen.ps1 fix #Requires to be valid in real Powershell (#31858) 2017-10-23 11:40:54 -07:00
win_dotnet_ngen.py win_dotnet_ngen: fix after broken in 2.4 (#31076) 2017-10-03 07:34:00 +11:00
win_dsc.ps1 win_dsc: improved parameter handling (#31556) 2017-11-06 09:44:04 +10:00
win_dsc.py win_dsc: improved parameter handling (#31556) 2017-11-06 09:44:04 +10:00
win_environment.ps1 fix #Requires to be valid in real Powershell (#31858) 2017-10-23 11:40:54 -07:00
win_environment.py win_environment: Make this the Windows reference module 2017-09-21 03:20:17 +02:00
win_eventlog.ps1 New Module: Manage Windows event logs (win_eventlog) (#27827) 2017-08-15 01:13:52 -04:00
win_eventlog.py Update metadata to 1.1 2017-08-15 23:12:08 -07:00
win_eventlog_entry.ps1 fix #Requires to be valid in real Powershell (#31858) 2017-10-23 11:40:54 -07:00
win_eventlog_entry.py Update metadata to 1.1 2017-08-15 23:12:08 -07:00
win_feature.ps1 Deprecated restart option in win_feature, added return docs 2017-05-03 17:06:02 -07:00
win_feature.py Remove deprecated restart: parameter from win_feature examples (#33848) 2017-12-13 16:48:45 +10:00
win_file.ps1 fix #Requires to be valid in real Powershell (#31858) 2017-10-23 11:40:54 -07:00
win_file.py Update metadata to 1.1 2017-08-15 23:12:08 -07:00
win_file_version.ps1 spelling fixes (non-trivial, changing messages) (#25094) 2017-06-01 10:45:19 +01:00
win_file_version.py Update metadata to 1.1 2017-08-15 23:12:08 -07:00
win_find.ps1 win_find: allow module to skip on files it fails to check (#32105) 2017-11-02 09:35:19 +10:00
win_find.py win_find: allow module to skip on files it fails to check (#32105) 2017-11-02 09:35:19 +10:00
win_firewall.ps1 win_firewall: check-mode support, integration tests (#25127) 2017-06-13 17:32:22 +01:00
win_firewall.py Modules metadata: fix invalid GitHub ID in author field (#31856) 2017-11-02 06:52:18 -04:00
win_firewall_rule.ps1 fix PS type conversion failure when using "all" profiles (#34383) 2018-01-02 20:25:46 -08:00
win_firewall_rule.py minor updates + tests to win_firewall_rule as per jborean93 review (#29148) 2017-10-10 16:23:08 +10:00
win_get_url.ps1 win_get_url: Changed basic auth from NetworkCredential to Base64 (#32389) 2017-12-19 06:38:44 +10:00
win_get_url.py win_get_url: Changed basic auth from NetworkCredential to Base64 (#32389) 2017-12-19 06:38:44 +10:00
win_group.ps1 win_group: Clean up and check-mode support (#21384) 2017-02-23 23:34:33 -08:00
win_group.py Update metadata to 1.1 2017-08-15 23:12:08 -07:00
win_group_membership.ps1 Rename win_group_member module to win_group_membership (#27614) 2017-08-02 12:06:39 +10:00
win_group_membership.py Update metadata to 1.1 2017-08-15 23:12:08 -07:00
win_hotfix.ps1 fix #Requires to be valid in real Powershell (#31858) 2017-10-23 11:40:54 -07:00
win_hotfix.py Update metadata to 1.1 2017-08-15 23:12:08 -07:00
win_iis_virtualdirectory.ps1 removed psobject to hashtables that were missed (#32710) 2017-11-15 14:51:16 -08:00
win_iis_virtualdirectory.py Update metadata to 1.1 2017-08-15 23:12:08 -07:00
win_iis_webapplication.ps1 Fix a typo in win_iis_webapplication.ps1 (#27417) 2017-07-28 17:24:08 +01:00
win_iis_webapplication.py Update metadata to 1.1 2017-08-15 23:12:08 -07:00
win_iis_webapppool.ps1 win_iis_webapppool: stop any passwords from being returned (#33931) 2017-12-15 09:50:44 +10:00
win_iis_webapppool.py Fix example with proceccModel in win_iis_webapppool (#32971) 2017-11-16 15:31:10 +01:00
win_iis_webbinding.ps1 win_iis_webbinding: Fix bug with ipaddress * returning multiple bindings (#34721) 2018-01-19 10:00:35 +10:00
win_iis_webbinding.py win_iis_webbinding: Fix bug with ipaddress * returning multiple bindings (#34721) 2018-01-19 10:00:35 +10:00
win_iis_website.ps1 Fixing issue with win_iis_website parameter types. Issue #34500 (#34501) 2018-01-08 10:26:16 +10:00
win_iis_website.py Update metadata to 1.1 2017-08-15 23:12:08 -07:00
win_lineinfile.ps1 windows: Two simple errors using Add-Warning (#25955) 2017-06-27 09:40:16 +10:00
win_lineinfile.py Update metadata to 1.1 2017-08-15 23:12:08 -07:00
win_mapped_drive.ps1 fix #Requires to be valid in real Powershell (#31858) 2017-10-23 11:40:54 -07:00
win_mapped_drive.py win_mapped_drive: add extra note around win_mapped_drive (#34478) 2018-01-05 08:00:09 +10:00
win_msg.ps1 win_msg: added doc about msg limit and included an explicit check for better error handling (#31078) 2017-10-03 07:32:30 +11:00
win_msg.py win_msg: added doc about msg limit and included an explicit check for better error handling (#31078) 2017-10-03 07:32:30 +11:00
win_nssm.ps1 Add delayed start to win_nssm (#32017) 2017-10-26 07:02:14 +10:00
win_nssm.py Add delayed start to win_nssm (#32017) 2017-10-26 07:02:14 +10:00
win_owner.ps1 fix #Requires to be valid in real Powershell (#31858) 2017-10-23 11:40:54 -07:00
win_owner.py Updated win_owner.py documentation to reflect recurse options (#31974) 2017-10-20 12:45:31 +02:00
win_package.ps1 win_package: remove case sensitive check for msi extension (#34476) 2018-01-05 07:11:22 +10:00
win_package.py win_package: add support for arguments as list (#32024) 2017-11-02 09:39:21 +10:00
win_pagefile.ps1 Adds win_pagefile module (#25605) 2017-08-29 17:23:13 -04:00
win_pagefile.py Fix metadata version. 2017-08-29 15:31:34 -07:00
win_path.ps1 new module: win_path (#20073) 2017-01-17 20:21:04 -08:00
win_path.py Update metadata to 1.1 2017-08-15 23:12:08 -07:00
win_ping.ps1 win_ping: Make full-functional 2017-01-27 13:23:01 -08:00
win_ping.py Clarify which ping module to use (#34935) 2018-01-17 14:02:06 +00:00
win_power_plan.ps1 fix #Requires to be valid in real Powershell (#31858) 2017-10-23 11:40:54 -07:00
win_power_plan.py added windows module win_power_plan with integration test (#27966) 2017-08-29 16:22:06 -04:00
win_product_facts.ps1 win_product_facts: New module to get Windows product information (#35206) 2018-01-23 10:44:55 +10:00
win_product_facts.py win_product_facts: New module to get Windows product information (#35206) 2018-01-23 10:44:55 +10:00
win_psexec.ps1 win_psexec: Change default for -nobanner (#24739) 2017-05-18 08:25:38 +01:00
win_psexec.py Fix booleans in win_psexec documentation 2017-08-21 19:58:17 +02:00
win_psmodule.ps1 New module: Add module to install/remove/register/unregiser windows powershell modules (windows/win_psmodule) (#23604) 2017-06-26 23:01:38 +02:00
win_psmodule.py Update metadata to 1.1 2017-08-15 23:12:08 -07:00
win_rabbitmq_plugin.ps1 [28017] Integration tests for win_rabbitmq_plugin (#28118) 2017-08-28 18:48:10 -04:00
win_rabbitmq_plugin.py Update metadata to 1.1 2017-08-15 23:12:08 -07:00
win_reboot.py win_reboot: change to sample system uptime instead of checking port status (#31767) 2017-11-20 16:01:22 -08:00
win_reg_stat.ps1 removed psobject to hashtables that were missed (#32710) 2017-11-15 14:51:16 -08:00
win_reg_stat.py win_reg_stat actually sets properties to be a dictionary, not a list (#31252) 2017-10-04 07:19:32 +11:00
win_regedit.ps1 Fix win_regedit module and tests. (#35478) 2018-01-30 07:57:03 +10:00
win_regedit.py win_regedit: added function to load a dat file for editing (#31289) 2017-10-18 06:30:33 +10:00
win_region.ps1 removed psobject to hashtables that were missed (#32710) 2017-11-15 14:51:16 -08:00
win_region.py Update metadata to 1.1 2017-08-15 23:12:08 -07:00
win_regmerge.ps1 win_regmerge: Clean up parameter handling (#21388) 2017-02-16 12:41:59 +00:00
win_regmerge.py Add module support to yamllint sanity test. (#34964) 2018-01-16 15:08:56 -08:00
win_robocopy.ps1 win_robocopy: Check-mode support, improved return code and docs (#25410) 2017-08-24 09:35:53 -04:00
win_robocopy.py win_robocopy: Check-mode support, improved return code and docs (#25410) 2017-08-24 09:35:53 -04:00
win_route.ps1 New module: Add module to add/remove a network static route on windows (windows/win_route) (#23405) 2017-06-07 10:25:50 -07:00
win_route.py Update metadata to 1.1 2017-08-15 23:12:08 -07:00
win_say.ps1 win_say: Fix issue, add integration tests (#26089) 2017-06-29 06:28:44 +10:00
win_say.py Update metadata to 1.1 2017-08-15 23:12:08 -07:00
win_scheduled_task.ps1 Implemented Trigger Repetition (#32938) 2018-01-12 08:08:50 +10:00
win_scheduled_task.py Implemented Trigger Repetition (#32938) 2018-01-12 08:08:50 +10:00
win_scheduled_task_stat.ps1 win_scheduled_task_stat: correctly return values from nested com values (#34671) 2018-01-10 10:23:04 +10:00
win_scheduled_task_stat.py win_scheduled_task_stat: correctly return values from nested com values (#34671) 2018-01-10 10:23:04 +10:00
win_security_policy.ps1 win_secedit: Added module with tests/diff mode (#26332) 2017-07-14 11:00:29 -07:00
win_security_policy.py win_security_policy: Add link to the win_user_right module (#34953) 2018-01-17 06:50:47 +10:00
win_service.ps1 win_service: quoted path fix (#32469) 2017-11-03 09:55:03 +10:00
win_service.py Fix typos and docs 2017-10-30 00:37:06 +01:00
win_share.ps1 fix #Requires to be valid in real Powershell (#31858) 2017-10-23 11:40:54 -07:00
win_share.py Fix SID Lookup Issues on Assorted Windows Modules (#28979) 2017-09-11 07:34:51 +10:00
win_shell.ps1 standardise the powershell FileUtils (#34969) 2018-01-17 14:16:34 +10:00
win_shell.py win_command win_shell: add stdin option (#31619) 2017-10-23 09:50:19 +10:00
win_shortcut.ps1 fix #Requires to be valid in real Powershell (#31858) 2017-10-23 11:40:54 -07:00
win_shortcut.py win_shortcut: Add hotkeys examples to documentation (#30694) 2017-09-22 05:37:15 +10:00
win_stat.ps1 standardise the powershell FileUtils (#34969) 2018-01-17 14:16:34 +10:00
win_stat.py win_stat: better support for links (#33005) 2017-12-12 14:07:56 +10:00
win_tempfile.ps1 win_tempfile: New module implementing tempfile on Windows (#21623) 2017-02-20 11:48:55 +00:00
win_tempfile.py Update metadata to 1.1 2017-08-15 23:12:08 -07:00
win_template.py Update metadata to 1.1 2017-08-15 23:12:08 -07:00
win_timezone.ps1 win_timezone: Add diff support, integration tests (#25284) 2017-06-14 17:34:46 +01:00
win_timezone.py Update metadata to 1.1 2017-08-15 23:12:08 -07:00
win_toast.ps1 fix #Requires to be valid in real Powershell (#31858) 2017-10-23 11:40:54 -07:00
win_toast.py Windows: A module for creating Toast notifications on Modern Windows versions. (#26675) 2017-08-29 19:19:18 -04:00
win_unzip.ps1 win_unzip: added support for Server core by using .net zip functions (#29272) 2017-09-11 18:30:24 -04:00
win_unzip.py added documentation info regarding win_unzip and recurse (#33846) 2017-12-13 16:34:05 +10:00
win_updates.ps1 win_updates: added blacklist and whitelist filtering of updates (#34907) 2018-01-18 16:29:46 -08:00
win_updates.py win_updates: added blacklist and whitelist filtering of updates (#34907) 2018-01-18 16:29:46 -08:00
win_uri.ps1 win_uri: fix elif to elseif (#32330) 2017-10-30 10:43:43 +10:00
win_uri.py win_environment: Make this the Windows reference module 2017-09-21 03:20:17 +02:00
win_user.ps1 Fix win_user warning message (#24263) 2017-05-04 12:53:19 -07:00
win_user.py win_user: add return info (#28975) 2017-09-07 16:13:51 +10:00
win_user_right.ps1 fix #Requires to be valid in real Powershell (#31858) 2017-10-23 11:40:54 -07:00
win_user_right.py Update metadata to 1.1 2017-08-15 23:12:08 -07:00
win_wait_for.ps1 win_wait_for: fix tests after attempts change (#35026) 2018-01-18 14:15:54 +10:00
win_wait_for.py win_wait_for: fix tests after attempts change (#35026) 2018-01-18 14:15:54 +10:00
win_wakeonlan.ps1 win_wakeonlan: New module to send Wake-On-Lan packets (#26232) 2017-07-10 07:15:22 +10:00
win_wakeonlan.py Update metadata to 1.1 2017-08-15 23:12:08 -07:00
win_webpicmd.ps1 Windows: Get rid of Set-Attr in remaining modules (#23525) 2017-04-13 11:34:33 -07:00
win_webpicmd.py Update metadata to 1.1 2017-08-15 23:12:08 -07:00
win_whoami.ps1 win_whoami: removed logon_sid from return results (#34425) 2018-01-03 17:57:44 -05:00
win_whoami.py win_whoami: removed logon_sid from return results (#34425) 2018-01-03 17:57:44 -05:00