Collections in the Ansible Namespace
+These are the collections documented here in the ansible namespace.
+ +
+
+
+
+
+
+
+
+
+ ' + + '' + + _("Hide Search Matches") + + "
" + ) + ); + }, + + /** + * helper function to hide the search marks again + */ + hideSearchWords: () => { + document + .querySelectorAll("#searchbox .highlight-link") + .forEach((el) => el.remove()); + document + .querySelectorAll("span.highlighted") + .forEach((el) => el.classList.remove("highlighted")); + localStorage.removeItem("sphinx_highlight_terms") + }, + + initEscapeListener: () => { + // only install a listener if it is really needed + if (!DOCUMENTATION_OPTIONS.ENABLE_SEARCH_SHORTCUTS) return; + + document.addEventListener("keydown", (event) => { + // bail for input elements + if (BLACKLISTED_KEY_CONTROL_ELEMENTS.has(document.activeElement.tagName)) return; + // bail with special keys + if (event.shiftKey || event.altKey || event.ctrlKey || event.metaKey) return; + if (DOCUMENTATION_OPTIONS.ENABLE_SEARCH_SHORTCUTS && (event.key === "Escape")) { + SphinxHighlight.hideSearchWords(); + event.preventDefault(); + } + }); + }, +}; + +_ready(() => { + /* Do not call highlightSearchWords() when we are on the search page. + * It will highlight words from the *previous* search query. + */ + if (typeof Search === "undefined") SphinxHighlight.highlightSearchWords(); + SphinxHighlight.initEscapeListener(); +}); diff --git a/tag/2.4.0/collections/ansible/index.html b/tag/2.4.0/collections/ansible/index.html new file mode 100644 index 00000000..3ee284e8 --- /dev/null +++ b/tag/2.4.0/collections/ansible/index.html @@ -0,0 +1,166 @@ + + + + + + + +
+
+
+
+
+ -
+
- Blog +
- Ansible community forum +
- Documentation +
+ Ansible Collections Documentation
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/tag/2.4.0/collections/ansible/windows/async_status_module.html b/tag/2.4.0/collections/ansible/windows/async_status_module.html
new file mode 100644
index 00000000..317d19fc
--- /dev/null
+++ b/tag/2.4.0/collections/ansible/windows/async_status_module.html
@@ -0,0 +1,395 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ -
+
- Blog +
- Ansible community forum +
- Documentation +
+ Ansible Collections Documentation
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/tag/2.4.0/collections/ansible/windows/index.html b/tag/2.4.0/collections/ansible/windows/index.html
new file mode 100644
index 00000000..5b6747ed
--- /dev/null
+++ b/tag/2.4.0/collections/ansible/windows/index.html
@@ -0,0 +1,267 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ ansible.windows.async_status module – Obtain status of asynchronous task
+
+
+
+Note
+This module is part of the ansible.windows collection (version 2.4.0).
+It is not included in ansible-core.
+To check whether it is installed, run ansible-galaxy collection list.
To install it, use: ansible-galaxy collection install ansible.windows.
To use it in a playbook, specify: ansible.windows.async_status.
Synopsis
+-
+
This module gets the status of an asynchronous task.
+
Parameters
+Parameter |
+Comments |
+
|---|---|
| + | Job or task identifier + |
+
| + | If If Choices: +
|
+
Attributes
+Attribute |
+Support |
+Description |
+
|---|---|---|
| + | Support: full + |
+Indicates this has a corresponding action plugin so some parts of the options can be executed on the controller + |
+
| + | Support: none + |
+Supports being used with the |
+
| + | Support: none + |
+Forces a ‘global’ task that does not execute per host, this bypasses per host templating and serial, throttle and other loop considerations +Conditionals will work as if This action will not work normally outside of lockstep strategies + |
+
| + | Support: full +added in ansible.windows 2.4.0 + |
+Can run in check_mode and return changed status prediction without modifying target + |
+
| + | Support: none + |
+Will return details on what has changed (or possibly needs changing in check_mode), when in diff mode + |
+
| + | Platform: windows + |
+Target OS/families that can be operated against + |
+
See Also
+
+
+See also
+-
+
- ansible.builtin.async_status
The official documentation on the ansible.builtin.async_status module.
+
+
Examples
+- name: Asynchronous yum task
+ ansible.windows.win_command: my.exe
+ async: 1000
+ poll: 0
+ register: long_cmd
+
+- name: Wait for asynchronous job to end
+ ansible.builtin.async_status:
+ jid: '{{ long_cmd.ansible_job_id }}'
+ register: job_result
+ until: job_result.finished
+ retries: 100
+ delay: 10
+Return Values
+Common return values are documented here, the following are the fields unique to this module:
+Key |
+Description |
+
|---|---|
| + | The asynchronous job id +Returned: success +Sample: |
+
| + | Path to erased job file +Returned: when file is erased + |
+
| + | Whether the asynchronous job has finished ( Returned: always +Sample: |
+
| + | Whether the asynchronous job has started ( Returned: always +Sample: |
+
| + | Any errors returned by async_wrapper +Returned: always + |
+
| + | Any output returned by async_wrapper +Returned: always + |
+
Collection links
+ +
+
+
+
+
+ -
+
- Blog +
- Ansible community forum +
- Documentation +
+ Ansible Collections Documentation
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/tag/2.4.0/collections/ansible/windows/quote_filter.html b/tag/2.4.0/collections/ansible/windows/quote_filter.html
new file mode 100644
index 00000000..f4a13800
--- /dev/null
+++ b/tag/2.4.0/collections/ansible/windows/quote_filter.html
@@ -0,0 +1,309 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Ansible.Windows
+Collection version 2.4.0
+ +Description
+Ansible collection for core Windows plugins.
+Authors:
+-
+
Jordan Borean @jborean93
+Matt Davis @nitzmahone
+
Supported ansible-core versions:
+-
+
2.14 or newer
+
Communication
+-
+
Matrix room
#windows:ansible.im: General usage and support questions.
+IRC channel
#ansible-windows(Libera network): +General usage and support questions.
+
+
+Plugin Index
+These are the plugins in the ansible.windows collection:
+Modules
+-
+
async_status module – Obtain status of asynchronous task
+setup module – Gathers facts about remote hosts
+slurp module – Slurps a file from remote nodes
+win_acl module – Set file/directory/registry/certificate permissions for a system user or group
+win_acl_inheritance module – Change ACL inheritance
+win_certificate_store module – Manages the certificate store
+win_command module – Executes a command on a remote Windows node
+win_copy module – Copies files to remote locations on windows hosts
+win_dns_client module – Configures DNS lookup on Windows hosts
+win_domain module – Ensures the existence of a Windows domain
+win_domain_controller module – Manage domain controller/member server state for a Windows host
+win_domain_membership module – Manage domain/workgroup membership for a Windows host
+win_dsc module – Invokes a PowerShell DSC configuration
+win_environment module – Modify environment variables on windows hosts
+win_feature module – Installs and uninstalls Windows Features on Windows Server
+win_file module – Creates, touches or removes files or directories
+win_find module – Return a list of files based on specific criteria
+win_get_url module – Downloads file from HTTP, HTTPS, or FTP to node
+win_group module – Add and remove local groups
+win_group_membership module – Manage Windows local group membership
+win_hostname module – Manages local Windows computer name
+win_optional_feature module – Manage optional Windows features
+win_owner module – Set owner
+win_package module – Installs/uninstalls an installable package
+win_path module – Manage Windows path environment variables
+win_ping module – A windows version of the classic ping module
+win_powershell module – Run PowerShell scripts
+win_reboot module – Reboot a windows machine
+win_reg_stat module – Get information about Windows registry keys
+win_regedit module – Add, change, or remove registry keys and values
+win_service module – Manage and query Windows services
+win_service_info module – Gather information about Windows services
+win_share module – Manage Windows shares
+win_shell module – Execute shell commands on target hosts
+win_stat module – Get information about Windows files
+win_tempfile module – Creates temporary files and directories
+win_template module – Template a file out to a remote server
+win_updates module – Download and install Windows updates
+win_uri module – Interacts with webservices
+win_user module – Manages local Windows user accounts
+win_user_right module – Manage Windows User Rights
+win_wait_for module – Waits for a condition before continuing
+win_whoami module – Get information about the current user and process
+
+
+Filter Plugins
+-
+
quote filter – Quotes argument(s) for various Windows shells
+
+
+
+
+See also
+List of collections with docs hosted here.
+
+
+
+
+
+ -
+
- Blog +
- Ansible community forum +
- Documentation +
+ Ansible Collections Documentation
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/tag/2.4.0/collections/ansible/windows/setup_module.html b/tag/2.4.0/collections/ansible/windows/setup_module.html
new file mode 100644
index 00000000..dbc502f8
--- /dev/null
+++ b/tag/2.4.0/collections/ansible/windows/setup_module.html
@@ -0,0 +1,286 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ ansible.windows.quote filter – Quotes argument(s) for various Windows shells
+
+
+
+Note
+This filter plugin is part of the ansible.windows collection (version 2.4.0).
+It is not included in ansible-core.
+To check whether it is installed, run ansible-galaxy collection list.
To install it, use: ansible-galaxy collection install ansible.windows.
To use it in a playbook, specify: ansible.windows.quote.
Synopsis
+-
+
Quotes argument(s) for the various Windows command line shells.
+Defaults to escaping arguments based on the Win32 C argv parsing rules that ansible.windows.win_command uses.
+Using shell=’cmd’ or shell=’powershell’ can be set to escape arguments for those respective shells.
+Each value is escaped in a way to ensure the process gets the literal argument passed in and meta chars escaped.
+
Input
+This describes the input of the filter, the value before | ansible.windows.quote.
Parameter |
+Comments |
+
|---|---|
| + | The string, list, or dict of values to quote. +A string or list of strings will be quoted. +When using a dict as the input, the final form will be in |
+
Keyword parameters
+This describes keyword parameters of the filter. These are the values key1=value1, key2=value2 and so on in the following
+example: input | ansible.windows.quote(key1=value1, key2=value2, ...)
Parameter |
+Comments |
+
|---|---|
| + | The shell to quote the arguments for. +By default no shell is used and the arguments are quoted with the Win32 C quoting rules. +Choices: +
|
+
See Also
+
+
+See also
+-
+
- ansible.windows.win_command
Executes a command on a remote Windows node.
+
+- ansible.windows.win_shell
Execute shell commands on target hosts.
+
+
Examples
+- name: Escape an argument for win_command
+ ansible.windows.win_command:
+ cmd: my.exe {{ argument1 | ansible.windows.quote }}
+
+- name: Escape an argument for PowerShell
+ ansible.windows.win_shell: |
+ $var = {{ argument1 | ansible.windows.quote(shell='powershell') }}
+ Write-Host $var
+Return Value
+Key |
+Description |
+
|---|---|
| + | The quoted input value(s) as a single space delimited string. +Returned: success + |
+
Collection links
+ +
+
+
+
+
+ -
+
- Blog +
- Ansible community forum +
- Documentation +
+ Ansible Collections Documentation
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/tag/2.4.0/collections/ansible/windows/slurp_module.html b/tag/2.4.0/collections/ansible/windows/slurp_module.html
new file mode 100644
index 00000000..dcaa933f
--- /dev/null
+++ b/tag/2.4.0/collections/ansible/windows/slurp_module.html
@@ -0,0 +1,302 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ ansible.windows.setup module – Gathers facts about remote hosts
+
+
+
+Note
+This module is part of the ansible.windows collection (version 2.4.0).
+It is not included in ansible-core.
+To check whether it is installed, run ansible-galaxy collection list.
To install it, use: ansible-galaxy collection install ansible.windows.
To use it in a playbook, specify: ansible.windows.setup.
Synopsis
+-
+
This module is automatically called by playbooks to gather useful variables about remote hosts that can be used in playbooks. It can also be executed directly by
/usr/bin/ansibleto check what variables are available to a host. Ansible provides many facts about the system, automatically.
+
Parameters
+Parameter |
+Comments |
+
|---|---|
| + | For internal use +Choices: +
|
+
| + | Path used for local ansible facts ( The returned fact will be named after the local file (without the extension suffix), e.g. |
+
| + | If supplied, restrict the additional facts collected to the given subset. +Can specify a list of values to specify a larger subset. +Values can also be used with an initial To avoid collecting even the min subset, specify To collect only specific facts, use Default: |
+
| + | Set the default timeout in seconds for individual fact gathering. +Default: |
+
Notes
+
+
+Note
+-
+
More ansible facts will be added with successive releases. If facter is installed, variables from these programs will also be snapshotted into the JSON file for usage in templating. These variables are prefixed with
facter_so it’s easy to tell their source. All variables are bubbled up to the caller.
+Some facts may be unavailable if running under a limited account.
+For more information about delegated facts, please check https://docs.ansible.com/ansible/latest/user_guide/playbooks_delegation.html#delegating-facts.
+
See Also
+
+
+See also
+-
+
- ansible.builtin.setup
The official documentation on the ansible.builtin.setup module.
+
+
Examples
+- name: run the setup facts
+ ansible.builtin.setup:
+Collection links
+ +
+
+
+
+
+ -
+
- Blog +
- Ansible community forum +
- Documentation +
+ Ansible Collections Documentation
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/tag/2.4.0/collections/ansible/windows/win_acl_inheritance_module.html b/tag/2.4.0/collections/ansible/windows/win_acl_inheritance_module.html
new file mode 100644
index 00000000..3d66f8e0
--- /dev/null
+++ b/tag/2.4.0/collections/ansible/windows/win_acl_inheritance_module.html
@@ -0,0 +1,303 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ ansible.windows.slurp module – Slurps a file from remote nodes
+
+
+
+Note
+This module is part of the ansible.windows collection (version 2.4.0).
+It is not included in ansible-core.
+To check whether it is installed, run ansible-galaxy collection list.
To install it, use: ansible-galaxy collection install ansible.windows.
To use it in a playbook, specify: ansible.windows.slurp.
Synopsis
+-
+
This module works like ansible.builtin.fetch. It is used for fetching a base64- encoded blob containing the data in a remote file.
+
Parameters
+Parameter |
+Comments |
+
|---|---|
| + | The file on the remote system to fetch. This must be a file, not a directory. + |
+
Notes
+
+
+Note
+-
+
This module returns an ‘in memory’ base64 encoded version of the file, take into account that this will require at least twice the RAM as the original file size.
+
See Also
+
+
+See also
+-
+
- ansible.builtin.fetch
The official documentation on the ansible.builtin.fetch module.
+
+- ansible.builtin.slurp
The official documentation on the ansible.builtin.slurp module.
+
+
Examples
+- name: Retrieve remote ini file on a Windows host
+ ansible.builtin.slurp:
+ src: C:\Program Files\Program\program.ini
+ register: program_conf
+
+- name: Print returned information
+ ansible.builtin.debug:
+ msg: "{{ program_conf['content'] | b64decode }}"
+Return Values
+Common return values are documented here, the following are the fields unique to this module:
+Key |
+Description |
+
|---|---|
| + | Encoded file content +Returned: success +Sample: |
+
| + | Type of encoding used for file +Returned: success +Sample: |
+
| + | Actual path of file slurped +Returned: success +Sample: |
+
Collection links
+ +
+
+
+
+
+ -
+
- Blog +
- Ansible community forum +
- Documentation +
+ Ansible Collections Documentation
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/tag/2.4.0/collections/ansible/windows/win_acl_module.html b/tag/2.4.0/collections/ansible/windows/win_acl_module.html
new file mode 100644
index 00000000..4f509be6
--- /dev/null
+++ b/tag/2.4.0/collections/ansible/windows/win_acl_module.html
@@ -0,0 +1,392 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ ansible.windows.win_acl_inheritance module – Change ACL inheritance
+
+
+
+Note
+This module is part of the ansible.windows collection (version 2.4.0).
+It is not included in ansible-core.
+To check whether it is installed, run ansible-galaxy collection list.
To install it, use: ansible-galaxy collection install ansible.windows.
To use it in a playbook, specify: ansible.windows.win_acl_inheritance.
Synopsis
+-
+
Change ACL (Access Control List) inheritance and optionally copy inherited ACE’s (Access Control Entry) to dedicated ACE’s or vice versa.
+
Parameters
+Parameter |
+Comments |
+
|---|---|
| + | Path to be used for changing inheritance +Support for registry keys have been added in |
+
| + | For For Choices: +
|
+
| + | Specify whether to enable present or disable absent ACL inheritance. +Choices: +
|
+
See Also
+
+
+See also
+-
+
- ansible.windows.win_acl
Set file/directory/registry/certificate permissions for a system user or group.
+
+- ansible.windows.win_file
Creates, touches or removes files or directories.
+
+- ansible.windows.win_stat
Get information about Windows files.
+
+
Examples
+- name: Disable inherited ACE's
+ ansible.windows.win_acl_inheritance:
+ path: C:\apache
+ state: absent
+
+- name: Disable and copy inherited ACE's
+ ansible.windows.win_acl_inheritance:
+ path: C:\apache
+ state: absent
+ reorganize: true
+
+- name: Enable and remove dedicated ACE's
+ ansible.windows.win_acl_inheritance:
+ path: C:\apache
+ state: present
+ reorganize: true
+
+- name: Disable registry key inherited ACE's
+ ansible.windows.win_acl_inheritance:
+ path: HKLM:\SOFTWARE\Secrets
+ state: absent
+
+- name: Disable and copy registry key inherited ACE's
+ ansible.windows.win_acl_inheritance:
+ path: HKLM:\SOFTWARE\Secrets
+ state: absent
+ reorganize: true
+
+- name: Enable and remove registry key dedicated ACE's
+ ansible.windows.win_acl_inheritance:
+ path: HKLM:\SOFTWARE\Secrets
+ state: present
+ reorganize: true
+Collection links
+ +
+
+
+
+
+ -
+
- Blog +
- Ansible community forum +
- Documentation +
+ Ansible Collections Documentation
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/tag/2.4.0/collections/ansible/windows/win_certificate_store_module.html b/tag/2.4.0/collections/ansible/windows/win_certificate_store_module.html
new file mode 100644
index 00000000..f5b9830f
--- /dev/null
+++ b/tag/2.4.0/collections/ansible/windows/win_certificate_store_module.html
@@ -0,0 +1,467 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ ansible.windows.win_acl module – Set file/directory/registry/certificate permissions for a system user or group
+
+
+
+Note
+This module is part of the ansible.windows collection (version 2.4.0).
+It is not included in ansible-core.
+To check whether it is installed, run ansible-galaxy collection list.
To install it, use: ansible-galaxy collection install ansible.windows.
To use it in a playbook, specify: ansible.windows.win_acl.
Synopsis
+-
+
Add or remove rights/permissions for a given user or group for the specified file, folder, registry key or AppPool identifies.
+
Parameters
+Parameter |
+Comments |
+
|---|---|
| + | Follow the symlinks and junctions to apply the ACLs to the target instead of the link. +Choices: +
|
+
| + | Inherit flags on the ACL rules. +Can be specified as a comma separated list, e.g. For more information on the choices see MSDN InheritanceFlags enumeration at https://msdn.microsoft.com/en-us/library/system.security.accesscontrol.inheritanceflags.aspx. +Defaults to Choices: +
|
+
| + | The path to the file or directory. + |
+
| + | Propagation flag on the ACL rules. +For more information on the choices see MSDN PropagationFlags enumeration at https://msdn.microsoft.com/en-us/library/system.security.accesscontrol.propagationflags.aspx. +Choices: +
|
+
| + | The rights/permissions that are to be allowed/denied for the specified user or group for the item at If If If path is a certificate key, rights can be |
+
| + | Specify whether to add Choices: +
|
+
| + | Specify whether to allow or deny the rights specified. +Choices: +
|
+
| + | User or Group to add specified rights to act on src file/folder or registry key. + |
+
Notes
+
+
+Note
+-
+
If adding ACL’s for AppPool identities, the Windows Feature “Web-Scripting-Tools” must be enabled.
+
See Also
+
+
+See also
+-
+
- ansible.windows.win_acl_inheritance
Change ACL inheritance.
+
+- ansible.windows.win_file
Creates, touches or removes files or directories.
+
+- ansible.windows.win_owner
Set owner.
+
+- ansible.windows.win_stat
Get information about Windows files.
+
+
Examples
+- name: Restrict write and execute access to User Fed-Phil
+ ansible.windows.win_acl:
+ user: Fed-Phil
+ path: C:\Important\Executable.exe
+ type: deny
+ rights: ExecuteFile,Write
+
+- name: Add IIS_IUSRS allow rights
+ ansible.windows.win_acl:
+ path: C:\inetpub\wwwroot\MySite
+ user: IIS_IUSRS
+ rights: FullControl
+ type: allow
+ state: present
+ inherit: ContainerInherit, ObjectInherit
+ propagation: 'None'
+
+- name: Set registry key right
+ ansible.windows.win_acl:
+ path: HKCU:\Bovine\Key
+ user: BUILTIN\Users
+ rights: EnumerateSubKeys
+ type: allow
+ state: present
+ inherit: ContainerInherit, ObjectInherit
+ propagation: 'None'
+
+- name: Remove FullControl AccessRule for IIS_IUSRS
+ ansible.windows.win_acl:
+ path: C:\inetpub\wwwroot\MySite
+ user: IIS_IUSRS
+ rights: FullControl
+ type: allow
+ state: absent
+ inherit: ContainerInherit, ObjectInherit
+ propagation: 'None'
+
+- name: Deny Intern
+ ansible.windows.win_acl:
+ path: C:\Administrator\Documents
+ user: Intern
+ rights: Read,Write,Modify,FullControl,Delete
+ type: deny
+ state: present
+
+- name: Set certificate private key FullControl to IIS_IUSRS
+ ansible.windows.win_acl:
+ path: Cert:\LocalMachine\My\168ba8c488463f88c6648466a22484b6189e165f
+ user: IIS_IUSRS
+ type: allow
+ state: present
+ rights: FullControl
+Collection links
+ +
+
+
+
+
+ -
+
- Blog +
- Ansible community forum +
- Documentation +
+ Ansible Collections Documentation
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/tag/2.4.0/collections/ansible/windows/win_command_module.html b/tag/2.4.0/collections/ansible/windows/win_command_module.html
new file mode 100644
index 00000000..0d31d059
--- /dev/null
+++ b/tag/2.4.0/collections/ansible/windows/win_command_module.html
@@ -0,0 +1,460 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ ansible.windows.win_certificate_store module – Manages the certificate store
+
+
+
+Note
+This module is part of the ansible.windows collection (version 2.4.0).
+It is not included in ansible-core.
+To check whether it is installed, run ansible-galaxy collection list.
To install it, use: ansible-galaxy collection install ansible.windows.
To use it in a playbook, specify: ansible.windows.win_certificate_store.
Synopsis
+-
+
Used to import/export and remove certificates and keys from the local certificate store.
+This module is not used to create certificates and will only manage existing certs as a file or in the store.
+It can be used to import PEM, DER, P7B, PKCS12 (PFX) certificates and export PEM, DER and PKCS12 certificates.
+
Parameters
+Parameter |
+Comments |
+
|---|---|
| + | The file type to export the certificate as when
When Choices: +
|
+
| + | Whether to allow the private key to be exported. +If Used when Choices: +
|
+
| + | Specifies where Windows will store the private key when it is imported. +When set to When set to When set to Used when See https://msdn.microsoft.com/en-us/library/system.security.cryptography.x509certificates.x509keystorageflags.aspx for more details. +Choices: +
|
+
| + | The password of the pkcs12 certificate key. +This is used when reading a pkcs12 certificate file or the password to set when If the pkcs12 file has no password set or no password should be set on the exported file, do not set this option. + |
+
| + | The path to a certificate file. +This is required when state is When state is |
+
| + | If If If When exporting a certificate, if path is a directory then the module will fail, otherwise the file will be replaced if needed. +Choices: +
|
+
| + | The store location to use when importing a certificate or searching for a certificate. +Can be set to Defaults to Must be set to any service name when Default: |
+
| + | The store name to use when importing a certificate or searching for a certificate. +
Default: |
+
| + | The store type to manage. +Use Use Choices: +
|
+
| + | The thumbprint as a hex string to either export or remove. +See the examples for how to specify the thumbprint. + |
+
Notes
+
+
+Note
+-
+
Some actions on PKCS12 certificates and keys may fail with the error
the specified network password is not correct, either use CredSSP or Kerberos with credential delegation, or usebecometo bypass these restrictions.
+The certificates must be located on the Windows host to be set with path.
+When importing a certificate for usage in IIS, it is generally required to use the
machinekey_storage option, as bothdefaultanduserwill make the private key unreadable to IIS APPPOOL identities and prevent binding the certificate to the https endpoint.
+
Examples
+- name: Import a certificate
+ ansible.windows.win_certificate_store:
+ path: C:\Temp\cert.pem
+ state: present
+
+- name: Import pfx certificate that is password protected
+ ansible.windows.win_certificate_store:
+ path: C:\Temp\cert.pfx
+ state: present
+ password: VeryStrongPasswordHere!
+ become: true
+ become_method: runas
+
+- name: Import pfx certificate without password and set private key as un-exportable
+ ansible.windows.win_certificate_store:
+ path: C:\Temp\cert.pfx
+ state: present
+ key_exportable: false
+ # usually you don't set this here but it is for illustrative purposes
+ vars:
+ ansible_winrm_transport: credssp
+
+- name: Remove a certificate based on file thumbprint
+ ansible.windows.win_certificate_store:
+ path: C:\Temp\cert.pem
+ state: absent
+
+- name: Remove a certificate based on thumbprint
+ ansible.windows.win_certificate_store:
+ thumbprint: BD7AF104CF1872BDB518D95C9534EA941665FD27
+ state: absent
+
+- name: Remove certificate based on thumbprint is CurrentUser/TrustedPublishers store
+ ansible.windows.win_certificate_store:
+ thumbprint: BD7AF104CF1872BDB518D95C9534EA941665FD27
+ state: absent
+ store_location: CurrentUser
+ store_name: TrustedPublisher
+
+- name: Export certificate as der encoded file
+ ansible.windows.win_certificate_store:
+ path: C:\Temp\cert.cer
+ state: exported
+ file_type: der
+
+- name: Export certificate and key as pfx encoded file
+ ansible.windows.win_certificate_store:
+ path: C:\Temp\cert.pfx
+ state: exported
+ file_type: pkcs12
+ password: AnotherStrongPass!
+ become: true
+ become_method: runas
+ become_user: SYSTEM
+
+- name: Import certificate be used by IIS
+ ansible.windows.win_certificate_store:
+ path: C:\Temp\cert.pfx
+ file_type: pkcs12
+ password: StrongPassword!
+ store_location: LocalMachine
+ key_storage: machine
+ state: present
+ become: true
+ become_method: runas
+ become_user: SYSTEM
+
+- name: Import certificate to be used for LDAPS
+ ansible.windows.win_certificate_store:
+ path: C:\Temp\cert.pfx
+ password: StrongPassword!
+ store_type: service
+ store_location: NTDS
+ key_exportable: false
+ key_storage: machine
+ state: present
+Return Values
+Common return values are documented here, the following are the fields unique to this module:
+Key |
+Description |
+
|---|---|
| + | A list of certificate thumbprints that were touched by the module. +Returned: success +Sample: |
+
Collection links
+ +
+
+
+
+
+ -
+
- Blog +
- Ansible community forum +
- Documentation +
+ Ansible Collections Documentation
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/tag/2.4.0/collections/ansible/windows/win_copy_module.html b/tag/2.4.0/collections/ansible/windows/win_copy_module.html
new file mode 100644
index 00000000..0833cb35
--- /dev/null
+++ b/tag/2.4.0/collections/ansible/windows/win_copy_module.html
@@ -0,0 +1,484 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ ansible.windows.win_command module – Executes a command on a remote Windows node
+
+
+
+Note
+This module is part of the ansible.windows collection (version 2.4.0).
+It is not included in ansible-core.
+To check whether it is installed, run ansible-galaxy collection list.
To install it, use: ansible-galaxy collection install ansible.windows.
To use it in a playbook, specify: ansible.windows.win_command.
Synopsis
+-
+
The
win_commandmodule takes the command name followed by a list of space-delimited arguments.
+The given command will be executed on all selected nodes. It will not be processed through the shell, so variables like
$env:HOMEand operations like"<",">","|", and";"will not work (use the ansible.windows.win_shell module if you need these features).
+For non-Windows targets, use the ansible.builtin.command module instead.
+
Parameters
+Parameter |
+Comments |
+
|---|---|
| + | The This is mutually exclusive with the There is no parameter actually named ‘_raw_params’. See the examples! + |
+
| + | A list that contains the executable and arguments to run. +The module will attempt to quote the arguments specified based on the Win32 C command-line argument rules. +Not all applications use the same quoting rules so the escaping may not work, for those scenarios use |
+
| + | Set the specified path as the current working directory before executing a command. + |
+
| + | The command and arguments to run. +This is mutually exclusive with the |
+
| + | A path or path filter pattern; when the referenced path exists on the target host, the task will be skipped. + |
+
| + | This option overrides the encoding of stdout/stderr output. +You can use this option when you need to run a command which ignore the console’s codepage. +You should only need to use this option in very rare circumstances. +This value can be any valid encoding |
+
| + | A path or path filter pattern; when the referenced path does not exist on the target host, the task will be skipped. + |
+
| + | Set the stdin of the command directly to the specified value. + |
+
Notes
+
+
+Note
+-
+
If you want to run a command through a shell (say you are using
<,>,|, etc), you actually want the ansible.windows.win_shell module instead. The ansible.windows.win_command module is much more secure as it’s not affected by the user’s environment.
+creates,removes, andchdircan be specified after the command. For instance, if you only want to run a command if a certain file does not exist, use this.
+Do not try to use the older style free form format and the newer style cmd/argv format. See the examples for how both of these formats are defined.
+
See Also
+
+
+See also
+-
+
- ansible.builtin.command
The official documentation on the ansible.builtin.command module.
+
+- community.windows.psexec
The official documentation on the community.windows.psexec module.
+
+- ansible.builtin.raw
The official documentation on the ansible.builtin.raw module.
+
+- community.windows.win_psexec
The official documentation on the community.windows.win_psexec module.
+
+- ansible.windows.win_shell
Execute shell commands on target hosts.
+
+
Examples
+# Older style using the free-form and args format. The command is on the same
+# line as the module and 'args' is used to define the options for win_command.
+- name: Save the result of 'whoami' in 'whoami_out'
+ ansible.windows.win_command: whoami
+ register: whoami_out
+
+- name: Run command that only runs if folder exists and runs from a specific folder
+ ansible.windows.win_command: wbadmin -backupTarget:C:\backup\
+ args:
+ chdir: C:\somedir\
+ creates: C:\backup\
+
+- name: Run an executable and send data to the stdin for the executable
+ ansible.windows.win_command: powershell.exe -
+ args:
+ stdin: Write-Host test
+
+# Newer style using module options. The command and other arguments are
+# defined as module options and are indended like another other module.
+- name: Run the 'whoami' executable with the '/all' argument
+ ansible.windows.win_command:
+ cmd: whoami.exe /all
+
+- name: Run executable in 'C:\Program Files' with a custom chdir
+ ansible.windows.win_command:
+ # When using cmd, the arguments need to be quoted manually
+ cmd: '"C:\Program Files\My Application\run.exe" "argument 1" -force'
+ chdir: C:\Windows\TEMP
+
+- name: Run executable using argv and have win_command escape the spaces as needed
+ ansible.windows.win_command:
+ # When using argv, each entry is quoted in the module
+ argv:
+ - C:\Program Files\My Application\run.exe
+ - argument 1
+ - -force
+Return Values
+Common return values are documented here, the following are the fields unique to this module:
+Key |
+Description |
+
|---|---|
| + | The command executed by the task +Returned: always +Sample: |
+
| + | The command execution delta time +Returned: always +Sample: |
+
| + | The command execution end time +Returned: always +Sample: |
+
| + | changed +Returned: always +Sample: |
+
| + | The command return code (0 means success) +Returned: always +Sample: |
+
| + | The command execution start time +Returned: always +Sample: |
+
| + | The command standard error +Returned: always +Sample: |
+
| + | The command standard error split in lines +Returned: always +Sample: |
+
| + | The command standard output +Returned: always +Sample: |
+
| + | The command standard output split in lines +Returned: always +Sample: |
+
Collection links
+ +
+
+
+
+
+ -
+
- Blog +
- Ansible community forum +
- Documentation +
+ Ansible Collections Documentation
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/tag/2.4.0/collections/ansible/windows/win_dns_client_module.html b/tag/2.4.0/collections/ansible/windows/win_dns_client_module.html
new file mode 100644
index 00000000..8b74e544
--- /dev/null
+++ b/tag/2.4.0/collections/ansible/windows/win_dns_client_module.html
@@ -0,0 +1,267 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ ansible.windows.win_copy module – Copies files to remote locations on windows hosts
+
+
+
+Note
+This module is part of the ansible.windows collection (version 2.4.0).
+It is not included in ansible-core.
+To check whether it is installed, run ansible-galaxy collection list.
To install it, use: ansible-galaxy collection install ansible.windows.
To use it in a playbook, specify: ansible.windows.win_copy.
Synopsis
+-
+
The
win_copymodule copies a file on the local box to remote windows locations.
+For non-Windows targets, use the ansible.builtin.copy module instead.
+
+
+Note
+This module has a corresponding action plugin.
+Parameters
+Parameter |
+Comments |
+
|---|---|
| + | Determine whether a backup should be created. +When set to No backup is taken when Choices: +
|
+
| + | When used instead of This is for simple values, for anything complex or with formatting please switch to the ansible.windows.win_template module. + |
+
| + | This option controls the autodecryption of source files using vault. +Choices: +
|
+
| + | Remote absolute path where the file should be copied to. +If Use \ for path separators or \\ when in “double quotes”. +If If If |
+
| + | If set to If set to If set to Choices: +
|
+
| + | This flag indicates that filesystem links in the source tree, if they exist, should be followed. +Choices: +
|
+
| + | If If Choices: +
|
+
| + | Local path to a file to copy to the remote server; can be absolute or relative. +If path is a directory, it is copied (including the source folder name) recursively to If path is a directory and ends with “/”, only the inside contents of that directory are copied to the destination. Otherwise, if it does not end with “/”, the directory itself with all contents is copied. +If path is a file and dest ends with “\”, the file is copied to the folder with the same filename. +Required unless using |
+
Notes
+
+
+Note
+-
+
Currently win_copy does not support copying symbolic links from both local to remote and remote to remote.
+It is recommended that backslashes
\are used instead of/when dealing with remote paths.
+Because win_copy runs over WinRM, it is not a very efficient transfer mechanism. If sending large files consider hosting them on a web service and using ansible.windows.win_get_url instead.
+When using become with a user that is not an Administrator, the remote temp directory must be set to one that is accessible to both the become and connection user with
ansible_remote_tmp. See the examples for more information.
+
See Also
+
+
+See also
+-
+
- ansible.builtin.assemble
The official documentation on the ansible.builtin.assemble module.
+
+- ansible.builtin.copy
The official documentation on the ansible.builtin.copy module.
+
+- ansible.windows.win_get_url
Downloads file from HTTP, HTTPS, or FTP to node.
+
+- community.windows.win_robocopy
The official documentation on the community.windows.win_robocopy module.
+
+
Examples
+- name: Copy a single file
+ ansible.windows.win_copy:
+ src: /srv/myfiles/foo.conf
+ dest: C:\Temp\renamed-foo.conf
+
+- name: Copy a single file, but keep a backup
+ ansible.windows.win_copy:
+ src: /srv/myfiles/foo.conf
+ dest: C:\Temp\renamed-foo.conf
+ backup: true
+
+- name: Copy a single file keeping the filename
+ ansible.windows.win_copy:
+ src: /src/myfiles/foo.conf
+ dest: C:\Temp\
+
+- name: Copy folder to C:\Temp (results in C:\Temp\temp_files)
+ ansible.windows.win_copy:
+ src: files/temp_files
+ dest: C:\Temp
+
+- name: Copy folder contents recursively
+ ansible.windows.win_copy:
+ src: files/temp_files/
+ dest: C:\Temp
+
+- name: Copy a single file where the source is on the remote host
+ ansible.windows.win_copy:
+ src: C:\Temp\foo.txt
+ dest: C:\ansible\foo.txt
+ remote_src: true
+
+- name: Copy a folder recursively where the source is on the remote host
+ ansible.windows.win_copy:
+ src: C:\Temp
+ dest: C:\ansible
+ remote_src: true
+
+- name: Set the contents of a file
+ ansible.windows.win_copy:
+ content: abc123
+ dest: C:\Temp\foo.txt
+
+- name: Copy a single file as another user
+ ansible.windows.win_copy:
+ src: NuGet.config
+ dest: '%AppData%\NuGet\NuGet.config'
+ vars:
+ ansible_become_user: user
+ ansible_become_password: pass
+ # The tmp dir must be set when using win_copy as another user
+ # This ensures the become user will have permissions for the operation
+ # Make sure to specify a folder both the ansible_user and the become_user have access to (i.e not %TEMP% which is user specific and requires Admin)
+ ansible_remote_tmp: 'c:\tmp'
+Return Values
+Common return values are documented here, the following are the fields unique to this module:
+Key |
+Description |
+
|---|---|
| + | Name of the backup file that was created. +Returned: if backup=yes +Sample: |
+
| + | SHA1 checksum of the file after running copy. +Returned: success, src is a file +Sample: |
+
| + | Destination file/path. +Returned: changed +Sample: |
+
| + | Whether a single file copy took place or a folder copy. +Returned: success +Sample: |
+
| + | Basename of the copied file. +Returned: changed, src is a file +Sample: |
+
| + | Size of the target, after execution. +Returned: changed, src is a file +Sample: |
+
| + | Source file used for the copy on the target machine. +Returned: changed +Sample: |
+
Collection links
+ +
+
+
+
+
+ -
+
- Blog +
- Ansible community forum +
- Documentation +
+ Ansible Collections Documentation
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/tag/2.4.0/collections/ansible/windows/win_domain_controller_module.html b/tag/2.4.0/collections/ansible/windows/win_domain_controller_module.html
new file mode 100644
index 00000000..ba1fa006
--- /dev/null
+++ b/tag/2.4.0/collections/ansible/windows/win_domain_controller_module.html
@@ -0,0 +1,453 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ ansible.windows.win_dns_client module – Configures DNS lookup on Windows hosts
+
+
+
+Note
+This module is part of the ansible.windows collection (version 2.4.0).
+It is not included in ansible-core.
+To check whether it is installed, run ansible-galaxy collection list.
To install it, use: ansible-galaxy collection install ansible.windows.
To use it in a playbook, specify: ansible.windows.win_dns_client.
Synopsis
+-
+
The ansible.windows.win_dns_client module configures the DNS client on Windows network adapters.
+
Parameters
+Parameter |
+Comments |
+
|---|---|
| + | Adapter name or list of adapter names for which to manage DNS settings (’*’ is supported as a wildcard value). +The adapter name used is the connection caption in the Network Control Panel or the InterfaceAlias of |
+
| + | Single or ordered list of DNS servers (IPv4 and IPv6 addresses) to configure for lookup. +An empty list will configure the adapter to use the DHCP-assigned values on connections where DHCP is enabled, or disable DNS lookup on statically-configured connections. +IPv6 DNS servers can only be set on Windows Server 2012 or newer, older hosts can only set IPv4 addresses. + |
+
Examples
+- name: Set a single address on the adapter named Ethernet
+ ansible.windows.win_dns_client:
+ adapter_names: Ethernet
+ dns_servers: 192.168.34.5
+
+- name: Set multiple lookup addresses on all visible adapters (usually physical adapters that are in the Up state), with debug logging to a file
+ ansible.windows.win_dns_client:
+ adapter_names: '*'
+ dns_servers:
+ - 192.168.34.5
+ - 192.168.34.6
+ log_path: C:\dns_log.txt
+
+- name: Set IPv6 DNS servers on the adapter named Ethernet
+ ansible.windows.win_dns_client:
+ adapter_names: Ethernet
+ dns_servers:
+ - '2001:db8::2'
+ - '2001:db8::3'
+
+- name: Configure all adapters whose names begin with Ethernet to use DHCP-assigned DNS values
+ ansible.windows.win_dns_client:
+ adapter_names: 'Ethernet*'
+ dns_servers: []
+Collection links
+ +
+
+
+
+
+ -
+
- Blog +
- Ansible community forum +
- Documentation +
+ Ansible Collections Documentation
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/tag/2.4.0/collections/ansible/windows/win_domain_membership_module.html b/tag/2.4.0/collections/ansible/windows/win_domain_membership_module.html
new file mode 100644
index 00000000..86d9e59e
--- /dev/null
+++ b/tag/2.4.0/collections/ansible/windows/win_domain_membership_module.html
@@ -0,0 +1,384 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ ansible.windows.win_domain_controller module – Manage domain controller/member server state for a Windows host
+
+
+
+Note
+This module is part of the ansible.windows collection (version 2.4.0).
+It is not included in ansible-core.
+To check whether it is installed, run ansible-galaxy collection list.
To install it, use: ansible-galaxy collection install ansible.windows.
To use it in a playbook, specify: ansible.windows.win_domain_controller.
DEPRECATED
+-
+
- Removed in: +
version 3.0.0
+
+- Why: +
This module has been moved into the
+microsoft.adcollection.
+- Alternative: +
Use the microsoft.ad.domain_controller module instead.
+
+
Synopsis
+-
+
Ensure that a Windows Server 2012+ host is configured as a domain controller or demoted to member server.
+This module may require subsequent use of the ansible.windows.win_reboot action if changes are made.
+
Parameters
+Parameter |
+Comments |
+
|---|---|
| + | The path to a directory on a fixed disk of the Windows host where the domain database will be created.. +If not set then the default path is |
+
| + | When |
+
| + | Password for the specified |
+
| + | Username of a domain admin for the target domain (necessary to promote or demote a domain controller). + |
+
| + | Specified the fully qualified, non-UNC path to a directory on a fixed disk of the local computer that will contain the domain log files. + |
+
| + | Whether to install the DNS service when creating the domain controller. +If not specified then the Choices: +
|
+
| + | The path to a directory on a fixed disk of the Windows host where the Install From Media See the Install using IFM guide for more information. + |
+
| + | Password to be assigned to the local |
+
| + | The path to log any debug information when running the module. +This option is deprecated and should not be used, it will be removed on the major release after This does not relate to the |
+
| + | Whether to install the domain controller as a read only replica for an existing domain. +Choices: +
|
+
| + | Safe mode password for the domain controller (required when |
+
| + | Specifies the name of an existing site where you can place the new domain controller. +This option is required when read_only is |
+
| + | Whether the target host should be a domain controller or a member server. +Choices: +
|
+
| + | The path to a directory on a fixed disk of the Windows host where the Sysvol folder will be created. +If not set then the default path is |
+
See Also
+
+
+See also
+-
+
- ansible.windows.win_domain
Ensures the existence of a Windows domain.
+
+- community.windows.win_domain_computer
The official documentation on the community.windows.win_domain_computer module.
+
+- community.windows.win_domain_group
The official documentation on the community.windows.win_domain_group module.
+
+- ansible.windows.win_domain_membership
Manage domain/workgroup membership for a Windows host.
+
+- community.windows.win_domain_user
The official documentation on the community.windows.win_domain_user module.
+
+
Examples
+- name: Ensure a server is a domain controller
+ ansible.windows.win_domain_controller:
+ dns_domain_name: ansible.vagrant
+ domain_admin_user: testguy@ansible.vagrant
+ domain_admin_password: password123!
+ safe_mode_password: password123!
+ state: domain_controller
+
+# note that without an action wrapper, in the case where a DC is demoted,
+# the task will fail with a 401 Unauthorized, because the domain credential
+# becomes invalid to fetch the final output over WinRM. This requires win_async
+# with credential switching (or other clever credential-switching
+# mechanism to get the output and trigger the required reboot)
+- name: Ensure a server is not a domain controller
+ ansible.windows.win_domain_controller:
+ domain_admin_user: testguy@ansible.vagrant
+ domain_admin_password: password123!
+ local_admin_password: password123!
+ state: member_server
+
+- name: Promote server as a read only domain controller
+ ansible.windows.win_domain_controller:
+ dns_domain_name: ansible.vagrant
+ domain_admin_user: testguy@ansible.vagrant
+ domain_admin_password: password123!
+ safe_mode_password: password123!
+ state: domain_controller
+ read_only: true
+ site_name: London
+
+- name: Promote server with custom paths
+ ansible.windows.win_domain_controller:
+ dns_domain_name: ansible.vagrant
+ domain_admin_user: testguy@ansible.vagrant
+ domain_admin_password: password123!
+ safe_mode_password: password123!
+ state: domain_controller
+ sysvol_path: D:\SYSVOL
+ database_path: D:\NTDS
+ domain_log_path: D:\NTDS
+ register: dc_promotion
+
+- name: Reboot after promotion
+ ansible.windows.win_reboot:
+ when: dc_promotion.reboot_required
+Return Values
+Common return values are documented here, the following are the fields unique to this module:
+Key |
+Description |
+
|---|---|
| + | True if changes were made that require a reboot. +Returned: always +Sample: |
+
Status
+-
+
This module will be removed in version 3.0.0. +[deprecated]
+For more information see DEPRECATED.
+
Collection links
+ +
+
+
+
+
+ -
+
- Blog +
- Ansible community forum +
- Documentation +
+ Ansible Collections Documentation
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/tag/2.4.0/collections/ansible/windows/win_domain_module.html b/tag/2.4.0/collections/ansible/windows/win_domain_module.html
new file mode 100644
index 00000000..a4edccd2
--- /dev/null
+++ b/tag/2.4.0/collections/ansible/windows/win_domain_module.html
@@ -0,0 +1,413 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ ansible.windows.win_domain_membership module – Manage domain/workgroup membership for a Windows host
+
+
+
+Note
+This module is part of the ansible.windows collection (version 2.4.0).
+It is not included in ansible-core.
+To check whether it is installed, run ansible-galaxy collection list.
To install it, use: ansible-galaxy collection install ansible.windows.
To use it in a playbook, specify: ansible.windows.win_domain_membership.
DEPRECATED
+-
+
- Removed in: +
version 3.0.0
+
+- Why: +
This module has been moved into the
+microsoft.adcollection.
+- Alternative: +
Use the microsoft.ad.membership module instead.
+
+
Synopsis
+-
+
Manages domain membership or workgroup membership for a Windows host. Also supports hostname changes.
+This module may require subsequent use of the ansible.windows.win_reboot action if changes are made.
+
Parameters
+Parameter |
+Comments |
+
|---|---|
| + | When |
+
| + | Password for the specified |
+
| + | Username of a domain admin for the target domain (required to join or leave the domain). + |
+
| + | The desired OU path for adding the computer object. +This is only used when adding the target host to a domain, if it is already a member then it is ignored. + |
+
| + | The desired hostname for the Windows host. + |
+
| + | Whether the target host should be a member of a domain or workgroup. +Choices: +
|
+
| + | When |
+
See Also
+
+
+See also
+-
+
- ansible.windows.win_domain
Ensures the existence of a Windows domain.
+
+- ansible.windows.win_domain_controller
Manage domain controller/member server state for a Windows host.
+
+- community.windows.win_domain_computer
The official documentation on the community.windows.win_domain_computer module.
+
+- community.windows.win_domain_group
The official documentation on the community.windows.win_domain_group module.
+
+- community.windows.win_domain_user
The official documentation on the community.windows.win_domain_user module.
+
+- ansible.windows.win_group
Add and remove local groups.
+
+- ansible.windows.win_group_membership
Manage Windows local group membership.
+
+- ansible.windows.win_user
Manages local Windows user accounts.
+
+
Examples
+# host should be a member of domain ansible.vagrant; module will ensure the hostname is mydomainclient
+# and will use the passed credentials to join domain if necessary.
+# Ansible connection should use local credentials if possible.
+# If a reboot is required, the second task will trigger one and wait until the host is available.
+- name: Play to join the hsots to a domain
+ hosts: winclient
+ gather_facts: false
+ tasks:
+ - name: Join host to the ansible.vagrant domain
+ ansible.windows.win_domain_membership:
+ dns_domain_name: ansible.vagrant
+ hostname: mydomainclient
+ domain_admin_user: testguy@ansible.vagrant
+ domain_admin_password: password123!
+ domain_ou_path: "OU=Windows,OU=Servers,DC=ansible,DC=vagrant"
+ state: domain
+ register: domain_state
+
+ - name: Reboot host after domain join
+ ansible.windows.win_reboot:
+ when: domain_state.reboot_required
+
+# Host should be in workgroup mywg- module will use the passed credentials to clean-unjoin domain if possible.
+# Ansible connection should use local credentials if possible.
+# The domain admin credentials can be sourced from a vault-encrypted variable
+- name: Play to set the hosts workgroup
+ hosts: winclient
+ gather_facts: false
+ tasks:
+ - name: Set workgroup to mywg
+ ansible.windows.win_domain_membership:
+ workgroup_name: mywg
+ domain_admin_user: '{{ win_domain_admin_user }}'
+ domain_admin_password: '{{ win_domain_admin_password }}'
+ state: workgroup
+Return Values
+Common return values are documented here, the following are the fields unique to this module:
+Key |
+Description |
+
|---|---|
| + | True if changes were made that require a reboot. +Returned: always +Sample: |
+
Status
+-
+
This module will be removed in version 3.0.0. +[deprecated]
+For more information see DEPRECATED.
+
Collection links
+ +
+
+
+
+
+ -
+
- Blog +
- Ansible community forum +
- Documentation +
+ Ansible Collections Documentation
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/tag/2.4.0/collections/ansible/windows/win_dsc_module.html b/tag/2.4.0/collections/ansible/windows/win_dsc_module.html
new file mode 100644
index 00000000..cfcc4444
--- /dev/null
+++ b/tag/2.4.0/collections/ansible/windows/win_dsc_module.html
@@ -0,0 +1,399 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ ansible.windows.win_domain module – Ensures the existence of a Windows domain
+
+
+
+Note
+This module is part of the ansible.windows collection (version 2.4.0).
+It is not included in ansible-core.
+To check whether it is installed, run ansible-galaxy collection list.
To install it, use: ansible-galaxy collection install ansible.windows.
To use it in a playbook, specify: ansible.windows.win_domain.
DEPRECATED
+-
+
- Removed in: +
version 3.0.0
+
+- Why: +
This module has been moved into the
+microsoft.adcollection.
+- Alternative: +
Use the microsoft.ad.domain module instead.
+
+
Synopsis
+-
+
Ensure that the domain named by
dns_domain_nameexists and is reachable.
+If the domain is not reachable, the domain is created in a new forest on the target Windows Server 2012R2+ host.
+This module may require subsequent use of the ansible.windows.win_reboot action if changes are made.
+
Parameters
+Parameter |
+Comments |
+
|---|---|
| + | Whether to create a DNS delegation that references the new DNS server that you install along with the domain controller. +Valid for Active Directory-integrated DNS only. +The default is computed automatically based on the environment. +Choices: +
|
+
| + | The path to a directory on a fixed disk of the Windows host where the domain database will be created. +If not set then the default path is |
+
| + | The DNS name of the domain which should exist and be reachable or reside on the target Windows host. + |
+
| + | Specifies the domain functional level of the first domain in the creation of a new forest. +The domain functional level cannot be lower than the forest functional level, but it can be higher. +The default is automatically computed and set. +Choices: +
|
+
| + | The NetBIOS name for the root domain in the new forest. +For NetBIOS names to be valid for use with this parameter they must be single label names of 15 characters or less, if not it will fail. +If this parameter is not set, then the default is automatically computed from the value of the domain_name parameter. + |
+
| + | Specifies the forest functional level for the new forest. +The default forest functional level in Windows Server is typically the same as the version you are running. +Choices: +
|
+
| + | Whether to install the DNS service when creating the domain controller. +Choices: +
|
+
| + | Specifies the fully qualified, non-UNC path to a directory on a fixed disk of the local computer where the log file for this operation is written. +If not set then the default path is |
+
| + | Safe mode password for the domain controller. + |
+
| + | The path to a directory on a fixed disk of the Windows host where the Sysvol file will be created. +If not set then the default path is |
+
See Also
+
+
+See also
+-
+
- ansible.windows.win_domain_controller
Manage domain controller/member server state for a Windows host.
+
+- community.windows.win_domain_computer
The official documentation on the community.windows.win_domain_computer module.
+
+- community.windows.win_domain_group
The official documentation on the community.windows.win_domain_group module.
+
+- ansible.windows.win_domain_membership
Manage domain/workgroup membership for a Windows host.
+
+- community.windows.win_domain_user
The official documentation on the community.windows.win_domain_user module.
+
+
Examples
+- name: Create new domain in a new forest on the target host
+ ansible.windows.win_domain:
+ dns_domain_name: ansible.vagrant
+ safe_mode_password: password123!
+
+- name: Create new Windows domain in a new forest with specific parameters
+ ansible.windows.win_domain:
+ create_dns_delegation: false
+ database_path: C:\Windows\NTDS
+ dns_domain_name: ansible.vagrant
+ domain_mode: Win2012R2
+ domain_netbios_name: ANSIBLE
+ forest_mode: Win2012R2
+ safe_mode_password: password123!
+ sysvol_path: C:\Windows\SYSVOL
+ register: domain_install
+Return Values
+Common return values are documented here, the following are the fields unique to this module:
+Key |
+Description |
+
|---|---|
| + | True if changes were made that require a reboot. +Returned: always +Sample: |
+
Status
+-
+
This module will be removed in version 3.0.0. +[deprecated]
+For more information see DEPRECATED.
+
Collection links
+ +
+
+
+
+
+ -
+
- Blog +
- Ansible community forum +
- Documentation +
+ Ansible Collections Documentation
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/tag/2.4.0/collections/ansible/windows/win_environment_module.html b/tag/2.4.0/collections/ansible/windows/win_environment_module.html
new file mode 100644
index 00000000..4b683b55
--- /dev/null
+++ b/tag/2.4.0/collections/ansible/windows/win_environment_module.html
@@ -0,0 +1,372 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ ansible.windows.win_dsc module – Invokes a PowerShell DSC configuration
+
+
+
+Note
+This module is part of the ansible.windows collection (version 2.4.0).
+It is not included in ansible-core.
+To check whether it is installed, run ansible-galaxy collection list.
To install it, use: ansible-galaxy collection install ansible.windows.
To use it in a playbook, specify: ansible.windows.win_dsc.
Synopsis
+-
+
Configures a resource using PowerShell DSC.
+Requires PowerShell version 5.0 or newer.
+Most of the options for this module are dynamic and will vary depending on the DSC Resource specified in resource_name.
+
Parameters
+Parameter |
+Comments |
+
|---|---|
| + | The ansible.windows.win_dsc module takes in multiple free form options based on the DSC resource being invoked by resource_name. +There is no option actually named This module will try and convert the option to the correct type required by the DSC resource and throw a warning if it fails. +If the type of the DSC resource option is a If the type of the DSC resource option is a If the type of the DSC resource option is an array, then a list should be provided but a comma separated string also work. Use a list where possible as no escaping is required and it works with more complex types list If the type of the DSC resource option is a |
+
| + | Can be used to configure the exact version of the DSC resource to be invoked. +Useful if the target node has multiple versions installed of the module containing the DSC resource. +If not specified, the module will follow standard PowerShell convention and use the highest version available. +Default: |
+
| + | The name of the DSC Resource to use. +Must be accessible to PowerShell using any of the default paths. + |
+
Notes
+
+
+Note
+-
+
By default there are a few builtin resources that come with PowerShell 5.0, See https://docs.microsoft.com/en-us/powershell/scripting/dsc/resources/resources for more information on these resources.
+Custom DSC resources can be installed with community.windows.win_psmodule using the name option.
+The DSC engine run’s each task as the SYSTEM account, any resources that need to be accessed with a different account need to have
PsDscRunAsCredentialset.
+To see the valid options for a DSC resource, run the module with
-vvvto show the possible module invocation. Default values are not shown in this output but are applied within the DSC engine.
+The DSC engine requires the HTTP WSMan listener to be online and its port configured as the default listener for HTTP. This is set up by default but if a custom HTTP port is used or only a HTTPS listener is present then the module will fail. See the examples for a way to check this out in PowerShell.
+The Local Configuration Manager
LCMon the targeted host in question should be disabled to avoid any conflicts with resources being applied by this module. See https://devblogs.microsoft.com/powershell/invoking-powershell-dsc-resources-directly/ for more information on hwo to disableLCM.
+
Examples
+- name: Verify the WSMan HTTP listener is active and configured correctly
+ ansible.windows.win_shell: |
+ $port = (Get-Item -LiteralPath WSMan:\localhost\Client\DefaultPorts\HTTP).Value
+ $onlinePorts = @(Get-ChildItem -LiteralPath WSMan:\localhost\Listener |
+ Where-Object { 'Transport=HTTP' -in $_.Keys } |
+ Get-ChildItem |
+ Where-Object Name -eq Port |
+ Select-Object -ExpandProperty Value)
+
+ if ($port -notin $onlinePorts) {
+ "The default client port $port is not set up as a WSMan HTTP listener, win_dsc will not work."
+ }
+
+- name: Extract zip file
+ ansible.windows.win_dsc:
+ resource_name: Archive
+ Ensure: Present
+ Path: C:\Temp\zipfile.zip
+ Destination: C:\Temp\Temp2
+
+- name: Install a Windows feature with the WindowsFeature resource
+ ansible.windows.win_dsc:
+ resource_name: WindowsFeature
+ Name: telnet-client
+
+- name: Edit HKCU reg key under specific user
+ ansible.windows.win_dsc:
+ resource_name: Registry
+ Ensure: Present
+ Key: HKEY_CURRENT_USER\ExampleKey
+ ValueName: TestValue
+ ValueData: TestData
+ PsDscRunAsCredential_username: '{{ ansible_user }}'
+ PsDscRunAsCredential_password: '{{ ansible_password }}'
+ no_log: true
+
+- name: Create file with multiple attributes
+ ansible.windows.win_dsc:
+ resource_name: File
+ DestinationPath: C:\ansible\dsc
+ Attributes: # can also be a comma separated string, e.g. 'Hidden, System'
+ - Hidden
+ - System
+ Ensure: Present
+ Type: Directory
+
+- name: Call DSC resource with DateTime option
+ ansible.windows.win_dsc:
+ resource_name: DateTimeResource
+ DateTimeOption: '2019-02-22T13:57:31.2311892+00:00'
+
+# more complex example using custom DSC resource and dict values
+- name: Setup the xWebAdministration module
+ ansible.windows.win_psmodule:
+ name: xWebAdministration
+ state: present
+
+- name: Create IIS Website with Binding and Authentication options
+ ansible.windows.win_dsc:
+ resource_name: xWebsite
+ Ensure: Present
+ Name: DSC Website
+ State: Started
+ PhysicalPath: C:\inetpub\wwwroot
+ BindingInfo: # Example of a CimInstance[] DSC parameter (list of dicts)
+ - Protocol: https
+ Port: 1234
+ CertificateStoreName: MY
+ CertificateThumbprint: C676A89018C4D5902353545343634F35E6B3A659
+ HostName: DSCTest
+ IPAddress: '*'
+ SSLFlags: '1'
+ - Protocol: http
+ Port: 4321
+ IPAddress: '*'
+ AuthenticationInfo: # Example of a CimInstance DSC parameter (dict)
+ Anonymous: false
+ Basic: true
+ Digest: false
+ Windows: true
+Return Values
+Common return values are documented here, the following are the fields unique to this module:
+Key |
+Description |
+
|---|---|
| + | The version of the dsc resource/module used. +Returned: always +Sample: |
+
| + | Flag returned from the DSC engine indicating whether or not the machine requires a reboot for the invoked changes to take effect. +Returned: always +Sample: |
+
| + | The verbose output as a list from executing the DSC Set method. +Returned: Ansible verbosity is -vvv or greater and a change occurred +Sample: |
+
| + | The verbose output as a list from executing the DSC test method. +Returned: Ansible verbosity is -vvv or greater +Sample: |
+
Collection links
+ +
+
+
+
+
+ -
+
- Blog +
- Ansible community forum +
- Documentation +
+ Ansible Collections Documentation
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/tag/2.4.0/collections/ansible/windows/win_feature_module.html b/tag/2.4.0/collections/ansible/windows/win_feature_module.html
new file mode 100644
index 00000000..cbc10786
--- /dev/null
+++ b/tag/2.4.0/collections/ansible/windows/win_feature_module.html
@@ -0,0 +1,423 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ ansible.windows.win_environment module – Modify environment variables on windows hosts
+
+
+
+Note
+This module is part of the ansible.windows collection (version 2.4.0).
+It is not included in ansible-core.
+To check whether it is installed, run ansible-galaxy collection list.
To install it, use: ansible-galaxy collection install ansible.windows.
To use it in a playbook, specify: ansible.windows.win_environment.
Synopsis
+-
+
Uses .net Environment to set or remove environment variables and can set at User, Machine or Process level.
+User level environment variables will be set, but not available until the user has logged off and on again.
+
Parameters
+Parameter |
+Comments |
+
|---|---|
| + | The level at which to set the environment variable. +Use Use Use Choices: +
|
+
| + | The name of the environment variable. Required when state=absent. + |
+
| + | Set to Set to When using variables, do not set this option. +Choices: +
|
+
| + | The value to store in the environment variable. +Must be set when state=present and cannot be an empty string. +Should be omitted for state=absent and variables. + |
+
| + | A dictionary where multiple environment variables can be defined at once. +Not valid when state is set. Variables with a value will be set ( level applies to all vars defined this way. + |
+
Notes
+
+
+Note
+-
+
This module is best-suited for setting the entire value of an environment variable. For safe element-based management of path-like environment vars, use the ansible.windows.win_path module.
+This module does not broadcast change events. This means that the minority of windows applications which can have their environment changed without restarting will not be notified and therefore will need restarting to pick up new environment settings. User level environment variables will require the user to log out and in again before they become available.
+In the return,
before_valueandvaluewill be set to the last values when using variables. It’s best to usevaluesin that case if you need to find a specific variable’s before and after values.
+
See Also
+
+
+See also
+-
+
- ansible.windows.win_path
Manage Windows path environment variables.
+
+
Examples
+- name: Set an environment variable for all users
+ ansible.windows.win_environment:
+ state: present
+ name: TestVariable
+ value: Test value
+ level: machine
+
+- name: Remove an environment variable for the current user
+ ansible.windows.win_environment:
+ state: absent
+ name: TestVariable
+ level: user
+
+- name: Set several variables at once
+ ansible.windows.win_environment:
+ level: machine
+ variables:
+ TestVariable: Test value
+ CUSTOM_APP_VAR: 'Very important value'
+ ANOTHER_VAR: '{{ my_ansible_var }}'
+
+- name: Set and remove multiple variables at once
+ ansible.windows.win_environment:
+ level: user
+ variables:
+ TestVariable: Test value
+ CUSTOM_APP_VAR: 'Very important value'
+ ANOTHER_VAR: '{{ my_ansible_var }}'
+ UNWANTED_VAR: '' # < this will be removed
+Return Values
+Common return values are documented here, the following are the fields unique to this module:
+Key |
+Description |
+
|---|---|
| + | the value of the environment key before a change, this is null if it didn’t exist +Returned: always +Sample: |
+
| + | the value the environment key has been set to, this is null if removed +Returned: always +Sample: |
+
| + | dictionary of before and after values; each key is a variable name, each value is another dict with Returned: always + |
+
Collection links
+ +
+
+
+
+
+ -
+
- Blog +
- Ansible community forum +
- Documentation +
+ Ansible Collections Documentation
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/tag/2.4.0/collections/ansible/windows/win_file_module.html b/tag/2.4.0/collections/ansible/windows/win_file_module.html
new file mode 100644
index 00000000..18897e4c
--- /dev/null
+++ b/tag/2.4.0/collections/ansible/windows/win_file_module.html
@@ -0,0 +1,288 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ ansible.windows.win_feature module – Installs and uninstalls Windows Features on Windows Server
+
+
+
+Note
+This module is part of the ansible.windows collection (version 2.4.0).
+It is not included in ansible-core.
+To check whether it is installed, run ansible-galaxy collection list.
To install it, use: ansible-galaxy collection install ansible.windows.
To use it in a playbook, specify: ansible.windows.win_feature.
Synopsis
+-
+
Installs or uninstalls Windows Roles or Features on Windows Server.
+This module uses the Add/Remove-WindowsFeature Cmdlets on Windows 2008 R2 and Install/Uninstall-WindowsFeature Cmdlets on Windows 2012, which are not available on client os machines.
+
Parameters
+Parameter |
+Comments |
+
|---|---|
| + | Adds the corresponding management tools to the specified feature. +Not supported in Windows 2008 R2 and will be ignored. +Choices: +
|
+
| + | Adds all subfeatures of the specified feature. +Choices: +
|
+
| + | Names of roles or features to install as a single feature or a comma-separated list of features. +To list all available features use the PowerShell command |
+
| + | Specify a source to install the feature from. +Not supported in Windows 2008 R2 and will be ignored. +Can either be |
+
| + | State of the features or roles on the system. +Choices: +
|
+
See Also
+
+
+See also
+-
+
- chocolatey.chocolatey.win_chocolatey
The official documentation on the chocolatey.chocolatey.win_chocolatey module.
+
+- ansible.windows.win_package
Installs/uninstalls an installable package.
+
+
Examples
+- name: Install IIS (Web-Server only)
+ ansible.windows.win_feature:
+ name: Web-Server
+ state: present
+
+- name: Install IIS (Web-Server and Web-Common-Http)
+ ansible.windows.win_feature:
+ name:
+ - Web-Server
+ - Web-Common-Http
+ state: present
+
+- name: Install NET-Framework-Core from file
+ ansible.windows.win_feature:
+ name: NET-Framework-Core
+ source: C:\Temp\iso\sources\sxs
+ state: present
+
+- name: Install IIS Web-Server with sub features and management tools
+ ansible.windows.win_feature:
+ name: Web-Server
+ state: present
+ include_sub_features: true
+ include_management_tools: true
+ register: win_feature
+
+- name: Reboot if installing Web-Server feature requires it
+ ansible.windows.win_reboot:
+ when: win_feature.reboot_required
+Return Values
+Common return values are documented here, the following are the fields unique to this module:
+Key |
+Description |
+
|---|---|
| + | The stringified exit code from the feature installation/removal command. +Returned: always +Sample: |
+
| + | List of features that were installed or removed. +Returned: success + |
+
| + | Feature display name. +Returned: always +Sample: |
+
| + | A list of KB article IDs that apply to the update. +Returned: always +Sample: |
+
| + | Any messages returned from the feature subsystem that occurred during installation or removal of this feature. +Returned: always +Sample: |
+
| + | True when the target server requires a reboot as a result of installing or removing this feature. +Returned: always +Sample: |
+
| + | DEPRECATED in Ansible 2.4 (refer to Returned: always +Sample: |
+
| + | The reason a feature installation or removal was skipped. +Returned: always +Sample: |
+
| + | If the feature installation or removal was successful. +Returned: always +Sample: |
+
| + | True when the target server indicates a reboot is required (no further updates can be installed until after a reboot). +This my be true even if not change had occurred as the value is derived from the server state. +Returned: success +Sample: |
+
Collection links
+ +
+
+
+
+
+ -
+
- Blog +
- Ansible community forum +
- Documentation +
+ Ansible Collections Documentation
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/tag/2.4.0/collections/ansible/windows/win_find_module.html b/tag/2.4.0/collections/ansible/windows/win_find_module.html
new file mode 100644
index 00000000..f1063951
--- /dev/null
+++ b/tag/2.4.0/collections/ansible/windows/win_find_module.html
@@ -0,0 +1,741 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ ansible.windows.win_file module – Creates, touches or removes files or directories
+
+
+
+Note
+This module is part of the ansible.windows collection (version 2.4.0).
+It is not included in ansible-core.
+To check whether it is installed, run ansible-galaxy collection list.
To install it, use: ansible-galaxy collection install ansible.windows.
To use it in a playbook, specify: ansible.windows.win_file.
Synopsis
+-
+
Creates (empty) files, updates file modification stamps of existing files, and can create or remove directories.
+Unlike ansible.builtin.file, does not modify ownership, permissions or manipulate links.
+For non-Windows targets, use the ansible.builtin.file module instead.
+
Parameters
+Parameter |
+Comments |
+
|---|---|
| + | Path to the file being managed. + |
+
| + | If If If If Choices: +
|
+
See Also
+
+
+See also
+-
+
- ansible.builtin.file
The official documentation on the ansible.builtin.file module.
+
+- ansible.windows.win_acl
Set file/directory/registry/certificate permissions for a system user or group.
+
+- ansible.windows.win_acl_inheritance
Change ACL inheritance.
+
+- ansible.windows.win_owner
Set owner.
+
+- ansible.windows.win_stat
Get information about Windows files.
+
+
Examples
+- name: Touch a file (creates if not present, updates modification time if present)
+ ansible.windows.win_file:
+ path: C:\Temp\foo.conf
+ state: touch
+
+- name: Remove a file, if present
+ ansible.windows.win_file:
+ path: C:\Temp\foo.conf
+ state: absent
+
+- name: Create directory structure
+ ansible.windows.win_file:
+ path: C:\Temp\folder\subfolder
+ state: directory
+
+- name: Remove directory structure
+ ansible.windows.win_file:
+ path: C:\Temp
+ state: absent
+Collection links
+ +
+
+
+
+
+ -
+
- Blog +
- Ansible community forum +
- Documentation +
+ Ansible Collections Documentation
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/tag/2.4.0/collections/ansible/windows/win_get_url_module.html b/tag/2.4.0/collections/ansible/windows/win_get_url_module.html
new file mode 100644
index 00000000..4c15706f
--- /dev/null
+++ b/tag/2.4.0/collections/ansible/windows/win_get_url_module.html
@@ -0,0 +1,621 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ ansible.windows.win_find module – Return a list of files based on specific criteria
+
+
+
+Note
+This module is part of the ansible.windows collection (version 2.4.0).
+It is not included in ansible-core.
+To check whether it is installed, run ansible-galaxy collection list.
To install it, use: ansible-galaxy collection install ansible.windows.
To use it in a playbook, specify: ansible.windows.win_find.
Synopsis
+-
+
Return a list of files based on specified criteria.
+Multiple criteria are AND’d together.
+For non-Windows targets, use the ansible.builtin.find module instead.
+
Parameters
+Parameter |
+Comments |
+
|---|---|
| + | Select files or folders whose age is equal to or greater than the specified time. +Use a negative age to find files equal to or less than the specified time. +You can choose seconds, minutes, hours, days or weeks by specifying the first letter of an of those words (e.g., “2s”, “10d”, 1w”). + |
+
| + | Choose the file property against which we compare The default attribute we compare with is the last modification time. +Choices: +
|
+
| + | Algorithm to determine the checksum of a file. +Will throw an error if the host is unable to use specified algorithm. +Choices: +
|
+
| + | Set the maximum number of levels to descend into. +Setting recurse to Default depth is unlimited. + |
+
| + | Type of file to search for. +Choices: +
|
+
| + | Set this to This needs to be used in conjunction with Choices: +
|
+
| + | Whether to return a checksum of the file in the return info (default sha1), use Choices: +
|
+
| + | Set this to include hidden files or folders. +Choices: +
|
+
| + | List of paths of directories to search for files or folders in. +This can be supplied as a single path or a list of paths. + |
+
| + | One or more (powershell or regex) patterns to compare filenames with. +The type of pattern matching is controlled by The patterns restrict the list of files or folders to be returned based on the filenames. +For a file to be matched it only has to match with one pattern in a list provided. + |
+
| + | Will recursively descend into the directory looking for files or folders. +Choices: +
|
+
| + | Select files or folders whose size is equal to or greater than the specified size. +Use a negative value to find files equal to or less than the specified size. +You can specify the size with a suffix of the byte type i.e. kilo = k, mega = m… +Size is not evaluated for symbolic links. + |
+
| + | Will set patterns to run as a regex check if set to Choices: +
|
+
Notes
+
+
+Note
+-
+
When scanning directories with a large number of files containing lots of data it is recommended to set
get_checksum=false. This will speed up the time it takes to scan the folders as getting a checksum needs to read the contents of every file it returns.
+
Examples
+- name: Find files in path
+ ansible.windows.win_find:
+ paths: D:\Temp
+
+- name: Find hidden files in path
+ ansible.windows.win_find:
+ paths: D:\Temp
+ hidden: true
+
+- name: Find files in multiple paths
+ ansible.windows.win_find:
+ paths:
+ - C:\Temp
+ - D:\Temp
+
+- name: Find files in directory while searching recursively
+ ansible.windows.win_find:
+ paths: D:\Temp
+ recurse: true
+
+- name: Find files in directory while following symlinks
+ ansible.windows.win_find:
+ paths: D:\Temp
+ recurse: true
+ follow: true
+
+- name: Find files with .log and .out extension using powershell wildcards
+ ansible.windows.win_find:
+ paths: D:\Temp
+ patterns: ['*.log', '*.out']
+
+- name: Find files in path based on regex pattern
+ ansible.windows.win_find:
+ paths: D:\Temp
+ patterns: out_\d{8}-\d{6}.log
+
+- name: Find files older than 1 day
+ ansible.windows.win_find:
+ paths: D:\Temp
+ age: 86400
+
+- name: Find files older than 1 day based on create time
+ ansible.windows.win_find:
+ paths: D:\Temp
+ age: 86400
+ age_stamp: ctime
+
+- name: Find files older than 1 day with unit syntax
+ ansible.windows.win_find:
+ paths: D:\Temp
+ age: 1d
+
+- name: Find files newer than 1 hour
+ ansible.windows.win_find:
+ paths: D:\Temp
+ age: -3600
+
+- name: Find files newer than 1 hour with unit syntax
+ ansible.windows.win_find:
+ paths: D:\Temp
+ age: -1h
+
+- name: Find files larger than 1MB
+ ansible.windows.win_find:
+ paths: D:\Temp
+ size: 1048576
+
+- name: Find files larger than 1GB with unit syntax
+ ansible.windows.win_find:
+ paths: D:\Temp
+ size: 1g
+
+- name: Find files smaller than 1MB
+ ansible.windows.win_find:
+ paths: D:\Temp
+ size: -1048576
+
+- name: Find files smaller than 1GB with unit syntax
+ ansible.windows.win_find:
+ paths: D:\Temp
+ size: -1g
+
+- name: Find folders/symlinks in multiple paths
+ ansible.windows.win_find:
+ paths:
+ - C:\Temp
+ - D:\Temp
+ file_type: directory
+
+- name: Find files and return SHA256 checksum of files found
+ ansible.windows.win_find:
+ paths: C:\Temp
+ get_checksum: true
+ checksum_algorithm: sha256
+
+- name: Find files and do not return the checksum
+ ansible.windows.win_find:
+ paths: C:\Temp
+ get_checksum: false
+Return Values
+Common return values are documented here, the following are the fields unique to this module:
+Key |
+Description |
+
|---|---|
| + | The number of files/folders that was checked. +Returned: always +Sample: |
+
| + | Information on the files/folders that match the criteria returned as a list of dictionary elements for each file matched. The entries are sorted by the path value alphabetically. +Returned: success + |
+
| + | attributes of the file at path in raw form. +Returned: success, path exists +Sample: |
+
| + | The checksum of a file based on checksum_algorithm specified. +Returned: success, path exists, path is a file, get_checksum == True +Sample: |
+
| + | The create time of the file represented in seconds since epoch. +Returned: success, path exists +Sample: |
+
| + | Whether the file exists, will always be true for ansible.windows.win_find. +Returned: success, path exists +Sample: |
+
| + | The extension of the file at path. +Returned: success, path exists, path is a file +Sample: |
+
| + | The name of the file. +Returned: success, path exists +Sample: |
+
| + | List of other files pointing to the same file (hard links), excludes the current file. +Returned: success, path exists +Sample: |
+
| + | If the path is ready for archiving or not. +Returned: success, path exists +Sample: |
+
| + | If the path is a directory or not. +Returned: success, path exists +Sample: |
+
| + | If the path is hidden or not. +Returned: success, path exists +Sample: |
+
| + | If the path is a junction point. +Returned: success, path exists +Sample: |
+
| + | If the path is a symbolic link. +Returned: success, path exists +Sample: |
+
| + | If the path is read only or not. +Returned: success, path exists +Sample: |
+
| + | If the path is a regular file or not. +Returned: success, path exists +Sample: |
+
| + | If the path is shared or not. +Returned: success, path exists +Sample: |
+
| + | The last access time of the file represented in seconds since epoch. +Returned: success, path exists +Sample: |
+
| + | The last modification time of the file represented in seconds since epoch. +Returned: success, path exists +Sample: |
+
| + | The target of the symlink normalized for the remote filesystem. +Returned: success, path exists, path is a symbolic link or junction point +Sample: |
+
| + | The target of the symlink. Note that relative paths remain relative, will return null if not a link. +Returned: success, path exists, path is a symbolic link or junction point +Sample: |
+
| + | Number of links to the file (hard links) +Returned: success, path exists +Sample: |
+
| + | The owner of the file. +Returned: success, path exists +Sample: |
+
| + | The full absolute path to the file. +Returned: success, path exists +Sample: |
+
| + | The name of share if folder is shared. +Returned: success, path exists, path is a directory and isshared == True +Sample: |
+
| + | The size in bytes of the file. +Returned: success, path exists, path is a file +Sample: |
+
| + | The number of files/folders that match the criteria. +Returned: always +Sample: |
+
Collection links
+ +
+
+
+
+
+ -
+
- Blog +
- Ansible community forum +
- Documentation +
+ Ansible Collections Documentation
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/tag/2.4.0/collections/ansible/windows/win_group_membership_module.html b/tag/2.4.0/collections/ansible/windows/win_group_membership_module.html
new file mode 100644
index 00000000..c0addbbd
--- /dev/null
+++ b/tag/2.4.0/collections/ansible/windows/win_group_membership_module.html
@@ -0,0 +1,340 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ ansible.windows.win_get_url module – Downloads file from HTTP, HTTPS, or FTP to node
+
+
+
+Note
+This module is part of the ansible.windows collection (version 2.4.0).
+It is not included in ansible-core.
+To check whether it is installed, run ansible-galaxy collection list.
To install it, use: ansible-galaxy collection install ansible.windows.
To use it in a playbook, specify: ansible.windows.win_get_url.
Synopsis
+-
+
Downloads files from HTTP, HTTPS, or FTP to the remote server.
+The remote server must have direct access to the remote resource.
+For non-Windows targets, use the ansible.builtin.get_url module instead.
+
Parameters
+Parameter |
+Comments |
+
|---|---|
| + | If a checksum is passed to this parameter, the digest of the destination file will be calculated after it is downloaded to ensure its integrity and verify that the transfer completed successfully. +This option cannot be set with checksum_url. + |
+
| + | Specifies the hashing algorithm used when calculating the checksum of the remote and destination file. +Choices: +
|
+
| + | Specifies a URL that contains the checksum values for the resource at url. +Like This option cannot be set with checksum. + |
+
| + | The path to the client certificate (.pfx) that is used for X509 authentication. This path can either be the path to the The WinRM connection must be authenticated with Other authentication types can set client_cert_password when the cert is password protected. + |
+
| + | The password for client_cert if the cert is password protected. + |
+
| + | The location to save the file at the URL. +Be sure to include a filename and extension as appropriate. + |
+
| + | Whether or the module should follow redirects. +
When following a redirected URL, the Choices: +
|
+
| + | If This works by sending an http HEAD request to retrieve last modified time of the requested resource, so for this to work, the remote web server must support HEAD requests. +Choices: +
|
+
| + | By default the authentication header is only sent when a webservice responses to an initial request with a 401 status. Since some basic auth services do not properly send a 401, logins will fail. +This option forces the sending of the Basic authentication header upon the original request. +Choices: +
|
+
| + | Extra headers to set on the request. +This should be a dictionary where the key is the header name and the value is the value for that header. + |
+
| + | Header to identify as, generally appears in web server logs. +This is set to the Default: |
+
| + | Specify how many times the module will redirect a connection to an alternative URI before the connection fails. +If set to Default: |
+
| + | The password for proxy_username. + |
+
| + | An explicit proxy to use for the request. +By default, the request will use the IE defined proxy unless use_proxy is set to |
+
| + | Uses the current user’s credentials when authenticating with a proxy host protected with Proxies that use The module will only have access to the user’s credentials if using If not using Choices: +
|
+
| + | The username to use for proxy authentication. + |
+
| + | The full URL of a file to download. + |
+
| + | The HTTP Method of the request. + |
+
| + | The password for url_username. + |
+
| + | Specifies how long the request can be pending before it times out (in seconds). +Set to Default: |
+
| + | The username to use for authentication. + |
+
| + | Uses the current user’s credentials when authenticating with a server protected with Sites that use The module will only have access to the user’s credentials if using If not using Choices: +
|
+
| + | If Choices: +
|
+
| + | If This should only be used on personally controlled sites using self-signed certificates. +Choices: +
|
+
Notes
+
+
+Note
+-
+
If your URL includes an escaped slash character (%2F) this module will convert it to a real slash. This is a result of the behaviour of the System.Uri class as described in the documentation.
+
See Also
+
+
+See also
+-
+
- ansible.builtin.get_url
The official documentation on the ansible.builtin.get_url module.
+
+- ansible.builtin.uri
The official documentation on the ansible.builtin.uri module.
+
+- ansible.windows.win_uri
Interacts with webservices.
+
+- community.windows.win_inet_proxy
The official documentation on the community.windows.win_inet_proxy module.
+
+
Examples
+- name: Download earthrise.jpg to specified path
+ ansible.windows.win_get_url:
+ url: http://www.example.com/earthrise.jpg
+ dest: C:\Users\RandomUser\earthrise.jpg
+
+- name: Download earthrise.jpg to specified path only if modified
+ ansible.windows.win_get_url:
+ url: http://www.example.com/earthrise.jpg
+ dest: C:\Users\RandomUser\earthrise.jpg
+ force: false
+
+- name: Download earthrise.jpg to specified path through a proxy server.
+ ansible.windows.win_get_url:
+ url: http://www.example.com/earthrise.jpg
+ dest: C:\Users\RandomUser\earthrise.jpg
+ proxy_url: http://10.0.0.1:8080
+ proxy_username: username
+ proxy_password: password
+
+- name: Download file from FTP with authentication
+ ansible.windows.win_get_url:
+ url: ftp://server/file.txt
+ dest: '%TEMP%\ftp-file.txt'
+ url_username: ftp-user
+ url_password: ftp-password
+
+- name: Download src with sha256 checksum url
+ ansible.windows.win_get_url:
+ url: http://www.example.com/earthrise.jpg
+ dest: C:\temp\earthrise.jpg
+ checksum_url: http://www.example.com/sha256sum.txt
+ checksum_algorithm: sha256
+ force: true
+
+- name: Download src with sha256 checksum url
+ ansible.windows.win_get_url:
+ url: http://www.example.com/earthrise.jpg
+ dest: C:\temp\earthrise.jpg
+ checksum: a97e6837f60cec6da4491bab387296bbcd72bdba
+ checksum_algorithm: sha1
+ force: true
+Return Values
+Common return values are documented here, the following are the fields unique to this module:
+Key |
+Description |
+
|---|---|
| + | <algorithm> checksum of the file after the download +Returned: success and dest has been downloaded +Sample: |
+
| + | <algorithm> checksum of the remote resource +Returned: force=true or dest did not exist +Sample: |
+
| + | destination file/path +Returned: always +Sample: |
+
| + | The elapsed seconds between the start of poll and the end of the module. +Returned: always +Sample: |
+
| + | Error message, or HTTP status message from web-server +Returned: always +Sample: |
+
| + | size of the dest file +Returned: success +Sample: |
+
| + | HTTP status code +Returned: always +Sample: |
+
| + | requested url +Returned: always +Sample: |
+
Collection links
+ +
+
+
+
+
+ -
+
- Blog +
- Ansible community forum +
- Documentation +
+ Ansible Collections Documentation
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/tag/2.4.0/collections/ansible/windows/win_group_module.html b/tag/2.4.0/collections/ansible/windows/win_group_module.html
new file mode 100644
index 00000000..db6beaf0
--- /dev/null
+++ b/tag/2.4.0/collections/ansible/windows/win_group_module.html
@@ -0,0 +1,273 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ ansible.windows.win_group_membership module – Manage Windows local group membership
+
+
+
+Note
+This module is part of the ansible.windows collection (version 2.4.0).
+It is not included in ansible-core.
+To check whether it is installed, run ansible-galaxy collection list.
To install it, use: ansible-galaxy collection install ansible.windows.
To use it in a playbook, specify: ansible.windows.win_group_membership.
Synopsis
+-
+
Allows the addition and removal of local, service and domain users, and domain groups from a local group.
+
Parameters
+Parameter |
+Comments |
+
|---|---|
| + | A list of members to ensure are present/absent from the group. +Accepts local users as .\username, and SERVERNAME\username. +Accepts domain users and groups as DOMAIN\username and username@DOMAIN. +Accepts service users as NT AUTHORITY\username. +Accepts all local, domain and service user types as username, favoring domain lookups when in a domain. + |
+
| + | Name of the local group to manage membership on. + |
+
| + | Desired state of the members in the group. +When Choices: +
|
+
See Also
+
+
+See also
+-
+
- community.windows.win_domain_group
The official documentation on the community.windows.win_domain_group module.
+
+- ansible.windows.win_domain_membership
Manage domain/workgroup membership for a Windows host.
+
+- ansible.windows.win_group
Add and remove local groups.
+
+
Examples
+- name: Add a local and domain user to a local group
+ ansible.windows.win_group_membership:
+ name: Remote Desktop Users
+ members:
+ - NewLocalAdmin
+ - DOMAIN\TestUser
+ state: present
+
+- name: Remove a domain group and service user from a local group
+ ansible.windows.win_group_membership:
+ name: Backup Operators
+ members:
+ - DOMAIN\TestGroup
+ - NT AUTHORITY\SYSTEM
+ state: absent
+
+- name: Ensure only a domain user exists in a local group
+ ansible.windows.win_group_membership:
+ name: Remote Desktop Users
+ members:
+ - DOMAIN\TestUser
+ state: pure
+Return Values
+Common return values are documented here, the following are the fields unique to this module:
+Key |
+Description |
+
|---|---|
| + | A list of members added when Returned: success and Sample: |
+
| + | A list of all local group members at completion; this is empty if the group contains no members. +Returned: success +Sample: |
+
| + | The name of the target local group. +Returned: always +Sample: |
+
| + | A list of members removed when Returned: success and Sample: |
+
Collection links
+ +
+
+
+
+
+ -
+
- Blog +
- Ansible community forum +
- Documentation +
+ Ansible Collections Documentation
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/tag/2.4.0/collections/ansible/windows/win_hostname_module.html b/tag/2.4.0/collections/ansible/windows/win_hostname_module.html
new file mode 100644
index 00000000..198ed331
--- /dev/null
+++ b/tag/2.4.0/collections/ansible/windows/win_hostname_module.html
@@ -0,0 +1,280 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ ansible.windows.win_group module – Add and remove local groups
+
+
+
+Note
+This module is part of the ansible.windows collection (version 2.4.0).
+It is not included in ansible-core.
+To check whether it is installed, run ansible-galaxy collection list.
To install it, use: ansible-galaxy collection install ansible.windows.
To use it in a playbook, specify: ansible.windows.win_group.
Synopsis
+-
+
Add and remove local groups.
+For non-Windows targets, please use the ansible.builtin.group module instead.
+
Parameters
+Parameter |
+Comments |
+
|---|---|
| + | Description of the group. + |
+
| + | Name of the group. + |
+
| + | Create or remove the group. +Choices: +
|
+
See Also
+
+
+See also
+-
+
- ansible.builtin.group
The official documentation on the ansible.builtin.group module.
+
+- community.windows.win_domain_group
The official documentation on the community.windows.win_domain_group module.
+
+- ansible.windows.win_group_membership
Manage Windows local group membership.
+
+
Examples
+- name: Create a new group
+ ansible.windows.win_group:
+ name: deploy
+ description: Deploy Group
+ state: present
+
+- name: Remove a group
+ ansible.windows.win_group:
+ name: deploy
+ state: absent
+Collection links
+ +
+
+
+
+
+ -
+
- Blog +
- Ansible community forum +
- Documentation +
+ Ansible Collections Documentation
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/tag/2.4.0/collections/ansible/windows/win_optional_feature_module.html b/tag/2.4.0/collections/ansible/windows/win_optional_feature_module.html
new file mode 100644
index 00000000..d4f1182b
--- /dev/null
+++ b/tag/2.4.0/collections/ansible/windows/win_optional_feature_module.html
@@ -0,0 +1,328 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ ansible.windows.win_hostname module – Manages local Windows computer name
+
+
+
+Note
+This module is part of the ansible.windows collection (version 2.4.0).
+It is not included in ansible-core.
+To check whether it is installed, run ansible-galaxy collection list.
To install it, use: ansible-galaxy collection install ansible.windows.
To use it in a playbook, specify: ansible.windows.win_hostname.
Synopsis
+-
+
Manages local Windows computer name.
+A reboot is required for the computer name to take effect.
+
Parameters
+Parameter |
+Comments |
+
|---|---|
| + | The hostname to set for the computer. + |
+
See Also
+
+
+See also
+-
+
- ansible.windows.win_dns_client
Configures DNS lookup on Windows hosts.
+
+
Examples
+- name: Change the hostname to sample-hostname
+ ansible.windows.win_hostname:
+ name: sample-hostname
+ register: res
+
+- name: Reboot
+ ansible.windows.win_reboot:
+ when: res.reboot_required
+Return Values
+Common return values are documented here, the following are the fields unique to this module:
+Key |
+Description |
+
|---|---|
| + | The original hostname that was set before it was changed. +Returned: always +Sample: |
+
| + | Whether a reboot is required to complete the hostname change. +Returned: always +Sample: |
+
Collection links
+ +
+
+
+
+
+ -
+
- Blog +
- Ansible community forum +
- Documentation +
+ Ansible Collections Documentation
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/tag/2.4.0/collections/ansible/windows/win_owner_module.html b/tag/2.4.0/collections/ansible/windows/win_owner_module.html
new file mode 100644
index 00000000..f735073f
--- /dev/null
+++ b/tag/2.4.0/collections/ansible/windows/win_owner_module.html
@@ -0,0 +1,273 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ ansible.windows.win_optional_feature module – Manage optional Windows features
+
+
+
+Note
+This module is part of the ansible.windows collection (version 2.4.0).
+It is not included in ansible-core.
+To check whether it is installed, run ansible-galaxy collection list.
To install it, use: ansible-galaxy collection install ansible.windows.
To use it in a playbook, specify: ansible.windows.win_optional_feature.
Synopsis
+-
+
Install or uninstall optional Windows features on non-Server Windows.
+This module uses the
Enable-WindowsOptionalFeatureandDisable-WindowsOptionalFeaturecmdlets.
+
Parameters
+Parameter |
+Comments |
+
|---|---|
| + | Whether to enable the parent feature and the parent’s dependencies. +Choices: +
|
+
| + | The name(s) of the feature to install. +This relates to To list all available features use the PowerShell command |
+
| + | Specify a source to install the feature from. +Can either be |
+
| + | Whether to ensure the feature is absent or present on the system. +Choices: +
|
+
See Also
+
+
+See also
+-
+
- chocolatey.chocolatey.win_chocolatey
The official documentation on the chocolatey.chocolatey.win_chocolatey module.
+
+- ansible.windows.win_feature
Installs and uninstalls Windows Features on Windows Server.
+
+- ansible.windows.win_package
Installs/uninstalls an installable package.
+
+
Examples
+- name: Install .Net 3.5
+ ansible.windows.win_optional_feature:
+ name: NetFx3
+ state: present
+
+- name: Install .Net 3.5 from source
+ ansible.windows.win_optional_feature:
+ name: NetFx3
+ source: \\share01\win10\sources\sxs
+ state: present
+
+- name: Install Microsoft Subsystem for Linux
+ ansible.windows.win_optional_feature:
+ name: Microsoft-Windows-Subsystem-Linux
+ state: present
+ register: wsl_status
+
+- name: Reboot if installing Linux Subsytem as feature requires it
+ ansible.windows.win_reboot:
+ when: wsl_status.reboot_required
+
+- name: Install multiple features in one task
+ ansible.windows.win_optional_feature:
+ name:
+ - NetFx3
+ - Microsoft-Windows-Subsystem-Linux
+ state: present
+Return Values
+Common return values are documented here, the following are the fields unique to this module:
+Key |
+Description |
+
|---|---|
| + | True when the target server requires a reboot to complete updates +Returned: success +Sample: |
+
Collection links
+ +
+
+
+
+
+ -
+
- Blog +
- Ansible community forum +
- Documentation +
+ Ansible Collections Documentation
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/tag/2.4.0/collections/ansible/windows/win_package_module.html b/tag/2.4.0/collections/ansible/windows/win_package_module.html
new file mode 100644
index 00000000..6a92b583
--- /dev/null
+++ b/tag/2.4.0/collections/ansible/windows/win_package_module.html
@@ -0,0 +1,776 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ ansible.windows.win_owner module – Set owner
+
+
+
+Note
+This module is part of the ansible.windows collection (version 2.4.0).
+It is not included in ansible-core.
+To check whether it is installed, run ansible-galaxy collection list.
To install it, use: ansible-galaxy collection install ansible.windows.
To use it in a playbook, specify: ansible.windows.win_owner.
Synopsis
+-
+
Set owner of files or directories.
+
Parameters
+Parameter |
+Comments |
+
|---|---|
| + | Path to be used for changing owner. + |
+
| + | Indicates if the owner should be changed recursively. +Choices: +
|
+
| + | Name to be used for changing owner. + |
+
See Also
+
+
+See also
+-
+
- ansible.windows.win_acl
Set file/directory/registry/certificate permissions for a system user or group.
+
+- ansible.windows.win_file
Creates, touches or removes files or directories.
+
+- ansible.windows.win_stat
Get information about Windows files.
+
+
Examples
+- name: Change owner of path
+ ansible.windows.win_owner:
+ path: C:\apache
+ user: apache
+ recurse: true
+
+- name: Set the owner of root directory
+ ansible.windows.win_owner:
+ path: C:\apache
+ user: SYSTEM
+ recurse: false
+Collection links
+ +
+
+
+
+
+ -
+
- Blog +
- Ansible community forum +
- Documentation +
+ Ansible Collections Documentation
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/tag/2.4.0/collections/ansible/windows/win_path_module.html b/tag/2.4.0/collections/ansible/windows/win_path_module.html
new file mode 100644
index 00000000..695d840a
--- /dev/null
+++ b/tag/2.4.0/collections/ansible/windows/win_path_module.html
@@ -0,0 +1,300 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ ansible.windows.win_package module – Installs/uninstalls an installable package
+
+
+
+Note
+This module is part of the ansible.windows collection (version 2.4.0).
+It is not included in ansible-core.
+To check whether it is installed, run ansible-galaxy collection list.
To install it, use: ansible-galaxy collection install ansible.windows.
To use it in a playbook, specify: ansible.windows.win_package.
Synopsis
+-
+
Installs or uninstalls software packages for Windows.
+Supports
.exe,.msi,.msp,.appx,.appxbundle,.msix, and.msixbundle.
+These packages can be sourced from the local file system, network file share or a url.
+See provider for more info on each package type that is supported.
+
Parameters
+Parameter |
+Comments |
+
|---|---|
| + | Any arguments the installer needs to either install or uninstall the package. +If the package is an MSI do not supply the This is only used for the Can be a list of arguments and the module will escape the arguments as necessary, it is recommended to use a string when dealing with MSI packages due to the unique escaping issues with msiexec. +When using a list of arguments each item in the list is considered to be a single argument. As such, if an argument in the list contains a space then Ansible will quote this to ensure that this is seen by Windows as a single argument. Should this behaviour not be what is required, the argument should be split into two separate list items. See the examples section for more detail. + |
+
| + | Set the specified path as the current working directory before installing or uninstalling a package. +This is only used for the |
+
| + | The path to the client certificate (.pfx) that is used for X509 authentication. This path can either be the path to the The WinRM connection must be authenticated with Other authentication types can set client_cert_password when the cert is password protected. + |
+
| + | The password for client_cert if the cert is password protected. + |
+
| + | Will check the existence of the path specified and use the result to determine whether the package is already installed. +You can use this in conjunction with |
+
| + | Will check the existing of the service specified and use the result to determine whether the package is already installed. +You can use this in conjunction with |
+
| + | Will check the file version property of the file at
You can use this in conjunction with |
+
| + | One or more return codes from the package installation that indicates success. +The return codes are read as a signed integer, any values greater than 2147483647 need to be represented as the signed equivalent, i.e. To convert a unsigned number to the signed equivalent you can run “[Int32](“0x{0:X}” -f ([UInt32]3221225477))”. +A return code of This is only used for the Default: |
+
| + | Whether or the module should follow redirects. +
When following a redirected URL, the Choices: +
|
+
| + | By default the authentication header is only sent when a webservice responses to an initial request with a 401 status. Since some basic auth services do not properly send a 401, logins will fail. +This option forces the sending of the Basic authentication header upon the original request. +Choices: +
|
+
| + | Extra headers to set on the request. +This should be a dictionary where the key is the header name and the value is the value for that header. + |
+
| + | Header to identify as, generally appears in web server logs. +This is set to the Default: |
+
| + | Specifies the path to a log file that is persisted after a package is installed or uninstalled. +This is only used for the When omitted, a temporary log file is used instead for those providers. +This is only valid for MSI files, use |
+
| + | Specify how many times the module will redirect a connection to an alternative URI before the connection fails. +If set to Default: |
+
| + | Location of the package to be installed or uninstalled. +This package can either be on the local file system, network share or a url. +When If If |
+
| + | The product id of the installed packaged. +This is used for checking whether the product is already installed and getting the uninstall information if For msi packages, this is the For msp packages, this is the For msix packages, this is the For registry (exe) packages, this is the registry key name under the registry paths specified in provider. +This value is ignored if This SHOULD be set when the package is an |
+
| + | Set the package provider to use when searching for a package. +The The The The The Choices: +
|
+
| + | The password for proxy_username. + |
+
| + | An explicit proxy to use for the request. +By default, the request will use the IE defined proxy unless use_proxy is set to |
+
| + | Uses the current user’s credentials when authenticating with a proxy host protected with Proxies that use The module will only have access to the user’s credentials if using If not using Choices: +
|
+
| + | The username to use for proxy authentication. + |
+
| + | Whether to install or uninstall the package. +The module uses product_id to determine whether the package is installed or not. +For all providers but Choices: +
|
+
| + | The HTTP Method of the request. + |
+
| + | The password for url_username. + |
+
| + | Specifies how long the request can be pending before it times out (in seconds). +Set to Default: |
+
| + | The username to use for authentication. + |
+
| + | Uses the current user’s credentials when authenticating with a server protected with Sites that use The module will only have access to the user’s credentials if using If not using Choices: +
|
+
| + | If Choices: +
|
+
| + | If This should only be used on personally controlled sites using self-signed certificates. +Choices: +
|
+
| + | The module will wait for the process it spawns to finish but any processes spawned in that child process as ignored. +Set to This is useful if the install/uninstaller is just a wrapper which then calls the actual installer as its own child process. When this option is This should not be required for most installers and setting to Requires Windows Server 2012 or Windows 8 or newer to use. +Choices: +
|
+
Notes
+
+
+Note
+-
+
When
state=absentand the product is an exe, the path may be different from what was used to install the package originally. If path is not set then the path used will be what is set underQuietUninstallStringorUninstallStringin the registry for that product_id.
+By default all msi installs and uninstalls will be run with the arguments
/log, /qn, /norestart.
+All the installation checks under
product_idandcreates_*add together, if one fails then the program is considered to be absent.
+
See Also
+
+
+See also
+-
+
- chocolatey.chocolatey.win_chocolatey
The official documentation on the chocolatey.chocolatey.win_chocolatey module.
+
+- community.windows.win_hotfix
The official documentation on the community.windows.win_hotfix module.
+
+- ansible.windows.win_updates
Download and install Windows updates.
+
+- community.windows.win_inet_proxy
The official documentation on the community.windows.win_inet_proxy module.
+
+
Examples
+- name: Install the Visual C thingy
+ ansible.windows.win_package:
+ path: http://download.microsoft.com/download/1/6/B/16B06F60-3B20-4FF2-B699-5E9B7962F9AE/VSU_4/vcredist_x64.exe
+ product_id: '{CF2BEA3C-26EA-32F8-AA9B-331F7E34BA97}'
+ arguments: /install /passive /norestart
+
+- name: Install Visual C thingy with list of arguments instead of a string
+ ansible.windows.win_package:
+ path: http://download.microsoft.com/download/1/6/B/16B06F60-3B20-4FF2-B699-5E9B7962F9AE/VSU_4/vcredist_x64.exe
+ product_id: '{CF2BEA3C-26EA-32F8-AA9B-331F7E34BA97}'
+ arguments:
+ - /install
+ - /passive
+ - /norestart
+
+- name: Install MSBuild thingy with arguments split to prevent quotes
+ ansible.windows.win_package:
+ path: https://download.visualstudio.microsoft.com/download/pr/9665567e-f580-4acd-85f2-bc94a1db745f/vs_BuildTools.exe
+ product_id: '{D1437F51-786A-4F57-A99C-F8E94FBA1BD8}'
+ arguments:
+ - --norestart
+ - --passive
+ - --wait
+ - --add
+ - Microsoft.Net.Component.4.6.1.TargetingPack
+ - --add
+ - Microsoft.Net.Component.4.6.TargetingPack
+
+- name: Install Remote Desktop Connection Manager from msi with a permanent log
+ ansible.windows.win_package:
+ path: https://download.microsoft.com/download/A/F/0/AF0071F3-B198-4A35-AA90-C68D103BDCCF/rdcman.msi
+ product_id: '{0240359E-6A4C-4884-9E94-B397A02D893C}'
+ state: present
+ log_path: D:\logs\vcredist_x64-exe-{{lookup('pipe', 'date +%Y%m%dT%H%M%S')}}.log
+
+- name: Install Application from msi with multiple properties for installer
+ ansible.windows.win_package:
+ path: C:\temp\Application.msi
+ state: present
+ arguments: >-
+ SERVICE=1
+ DBNAME=ApplicationDB
+ DBSERVER=.\SQLEXPRESS
+ INSTALLDIR="C:\Program Files (x86)\App lication\App Server"
+
+- name: Install Microsoft® SQL Server® 2019 Express (DPAPI example)
+ ansible.windows.win_package:
+ path: C:\temp\SQLEXPR_x64_ENU\SETUP.EXE
+ product_id: Microsoft SQL Server SQL2019
+ arguments:
+ - SAPWD=VeryHardPassword
+ - /ConfigurationFile=C:\temp\configuration.ini
+ become: true
+ vars:
+ ansible_become_method: runas
+ ansible_become_user: "{{ user }}"
+ ansible_become_pass: "{{ password }}"
+
+- name: Uninstall Remote Desktop Connection Manager
+ ansible.windows.win_package:
+ product_id: '{0240359E-6A4C-4884-9E94-B397A02D893C}'
+ state: absent
+
+- name: Install Remote Desktop Connection Manager locally omitting the product_id
+ ansible.windows.win_package:
+ path: C:\temp\rdcman.msi
+ state: present
+
+- name: Uninstall Remote Desktop Connection Manager from local MSI omitting the product_id
+ ansible.windows.win_package:
+ path: C:\temp\rdcman.msi
+ state: absent
+
+# 7-Zip exe doesn't use a guid for the Product ID
+- name: Install 7zip from a network share with specific credentials
+ ansible.windows.win_package:
+ path: \\domain\programs\7z.exe
+ product_id: 7-Zip
+ arguments: /S
+ state: present
+ become: true
+ become_method: runas
+ become_flags: logon_type=new_credential logon_flags=netcredentials_only
+ vars:
+ ansible_become_user: DOMAIN\User
+ ansible_become_password: Password
+
+- name: Install 7zip and use a file version for the installation check
+ ansible.windows.win_package:
+ path: C:\temp\7z.exe
+ creates_path: C:\Program Files\7-Zip\7z.exe
+ creates_version: 16.04
+ state: present
+
+- name: Uninstall 7zip from the exe
+ ansible.windows.win_package:
+ path: C:\Program Files\7-Zip\Uninstall.exe
+ product_id: 7-Zip
+ arguments: /S
+ state: absent
+
+- name: Uninstall 7zip without specifying the path
+ ansible.windows.win_package:
+ product_id: 7-Zip
+ arguments: /S
+ state: absent
+
+- name: Install application and override expected return codes
+ ansible.windows.win_package:
+ path: https://download.microsoft.com/download/1/6/7/167F0D79-9317-48AE-AEDB-17120579F8E2/NDP451-KB2858728-x86-x64-AllOS-ENU.exe
+ product_id: '{7DEBE4EB-6B40-3766-BB35-5CBBC385DA37}'
+ arguments: '/q /norestart'
+ state: present
+ expected_return_code: [0, 666, 3010]
+
+- name: Install a .msp patch
+ ansible.windows.win_package:
+ path: C:\Patches\Product.msp
+ state: present
+
+- name: Remove a .msp patch
+ ansible.windows.win_package:
+ product_id: '{AC76BA86-A440-FFFF-A440-0C13154E5D00}'
+ state: absent
+
+- name: Enable installation of 3rd party MSIX packages
+ ansible.windows.win_regedit:
+ path: HKLM:\SOFTWARE\Microsoft\Windows\CurrentVersion\AppModelUnlock
+ name: AllowAllTrustedApps
+ data: 1
+ type: dword
+ state: present
+
+- name: Install an MSIX package for the current user
+ ansible.windows.win_package:
+ path: C:\Installers\Calculator.msix # Can be .appx, .msixbundle, or .appxbundle
+ state: present
+
+- name: Uninstall an MSIX package using the product_id
+ ansible.windows.win_package:
+ product_id: InputApp
+ state: absent
+Return Values
+Common return values are documented here, the following are the fields unique to this module:
+Key |
+Description |
+
|---|---|
| + | The contents of the MSI or MSP log. +Returned: installation/uninstallation failure for MSI or MSP packages +Sample: |
+
| + | The return code of the package process. +Returned: change occurred +Sample: |
+
| + | Whether a reboot is required to finalise package. This is set to true if the executable return code is 3010. +Returned: always +Sample: |
+
| + | The stderr stream of the package process. +Returned: failure during install or uninstall +Sample: |
+
| + | The stdout stream of the package process. +Returned: failure during install or uninstall +Sample: |
+
Collection links
+ +
+
+
+
+
+ -
+
- Blog +
- Ansible community forum +
- Documentation +
+ Ansible Collections Documentation
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/tag/2.4.0/collections/ansible/windows/win_ping_module.html b/tag/2.4.0/collections/ansible/windows/win_ping_module.html
new file mode 100644
index 00000000..25cc3352
--- /dev/null
+++ b/tag/2.4.0/collections/ansible/windows/win_ping_module.html
@@ -0,0 +1,275 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ ansible.windows.win_path module – Manage Windows path environment variables
+
+
+
+Note
+This module is part of the ansible.windows collection (version 2.4.0).
+It is not included in ansible-core.
+To check whether it is installed, run ansible-galaxy collection list.
To install it, use: ansible-galaxy collection install ansible.windows.
To use it in a playbook, specify: ansible.windows.win_path.
Synopsis
+-
+
Allows element-based ordering, addition, and removal of Windows path environment variables.
+
Parameters
+Parameter |
+Comments |
+
|---|---|
| + | A single path element, or a list of path elements (ie, directories) to add or remove. +When multiple elements are included in the list (and Variable expansions (eg, Any existing path elements not mentioned in New path elements are appended to the path, and existing path elements may be moved closer to the end to satisfy the requested ordering. +Paths are compared in a case-insensitive fashion, and trailing backslashes are ignored for comparison purposes. However, note that trailing backslashes in YAML require quotes. + |
+
| + | Target path environment variable name. +Default: |
+
| + | The level at which the environment variable specified by Choices: +
|
+
| + | Whether the path elements specified in Choices: +
|
+
Notes
+
+
+Note
+-
+
This module is for modifying individual elements of path-like environment variables. For general-purpose management of other environment vars, use the ansible.windows.win_environment module.
+This module does not broadcast change events. This means that the minority of windows applications which can have their environment changed without restarting will not be notified and therefore will need restarting to pick up new environment settings.
+User level environment variables will require an interactive user to log out and in again before they become available.
+
See Also
+
+
+See also
+-
+
- ansible.windows.win_environment
Modify environment variables on windows hosts.
+
+
Examples
+- name: Ensure that system32 and Powershell are present on the global system path, and in the specified order
+ ansible.windows.win_path:
+ elements:
+ - '%SystemRoot%\system32'
+ - '%SystemRoot%\system32\WindowsPowerShell\v1.0'
+
+- name: Ensure that C:\Program Files\MyJavaThing is not on the current user's CLASSPATH
+ ansible.windows.win_path:
+ name: CLASSPATH
+ elements: C:\Program Files\MyJavaThing
+ scope: user
+ state: absent
+Collection links
+ +
+
+
+
+
+ -
+
- Blog +
- Ansible community forum +
- Documentation +
+ Ansible Collections Documentation
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/tag/2.4.0/collections/ansible/windows/win_powershell_module.html b/tag/2.4.0/collections/ansible/windows/win_powershell_module.html
new file mode 100644
index 00000000..d181404c
--- /dev/null
+++ b/tag/2.4.0/collections/ansible/windows/win_powershell_module.html
@@ -0,0 +1,859 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ ansible.windows.win_ping module – A windows version of the classic ping module
+
+
+
+Note
+This module is part of the ansible.windows collection (version 2.4.0).
+It is not included in ansible-core.
+To check whether it is installed, run ansible-galaxy collection list.
To install it, use: ansible-galaxy collection install ansible.windows.
To use it in a playbook, specify: ansible.windows.win_ping.
Synopsis
+-
+
Checks management connectivity of a windows host.
+This is NOT ICMP ping, this is just a trivial test module.
+For non-Windows targets, use the ansible.builtin.ping module instead.
+
Parameters
+Parameter |
+Comments |
+
|---|---|
| + | Alternate data to return instead of ‘pong’. +If this parameter is set to Default: |
+
See Also
+
+
+See also
+-
+
- ansible.builtin.ping
The official documentation on the ansible.builtin.ping module.
+
+
Examples
+# Test connectivity to a windows host
+# ansible winserver -m ansible.windows.win_ping
+
+- name: Example from an Ansible Playbook
+ ansible.windows.win_ping:
+
+- name: Induce an exception to see what happens
+ ansible.windows.win_ping:
+ data: crash
+Return Values
+Common return values are documented here, the following are the fields unique to this module:
+Key |
+Description |
+
|---|---|
| + | Value provided with the data parameter. +Returned: success +Sample: |
+
Collection links
+ +
+
+
+
+
+ -
+
- Blog +
- Ansible community forum +
- Documentation +
+ Ansible Collections Documentation
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/tag/2.4.0/collections/ansible/windows/win_reboot_module.html b/tag/2.4.0/collections/ansible/windows/win_reboot_module.html
new file mode 100644
index 00000000..dd7445f1
--- /dev/null
+++ b/tag/2.4.0/collections/ansible/windows/win_reboot_module.html
@@ -0,0 +1,382 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ ansible.windows.win_powershell module – Run PowerShell scripts
+
+
+Note
+This module is part of the ansible.windows collection (version 2.4.0).
+It is not included in ansible-core.
+To check whether it is installed, run ansible-galaxy collection list.
To install it, use: ansible-galaxy collection install ansible.windows.
To use it in a playbook, specify: ansible.windows.win_powershell.
New in ansible.windows 1.5.0
+ +Synopsis
+-
+
Runs a PowerShell script and outputs the data in a structured format.
+Use ansible.windows.win_command or ansible.windows.win_shell to run a traditional PowerShell process with stdout, stderr, and rc results.
+
Parameters
+Parameter |
+Comments |
+
|---|---|
| + | A list of arguments to pass to executable when running a script in another PowerShell process. +These are not arguments to pass to script, use parameters for that purpose. + |
+
| + | The PowerShell location to set when starting the script. +This can be a location in any of the PowerShell providers. +The default location is dependent on many factors, if relative paths are used then set this option. + |
+
| + | A path or path filter pattern; when the referenced path exists on the target host, the task will be skipped. + |
+
| + | How deep the return values are serialized for This also controls the depth of the diff output set by Setting this to a higher value can dramatically increase the amount of data that needs to be returned. +Default: |
+
| + | The
Choices: +
|
+
| + | A custom PowerShell executable to run the script in. +When not defined the script will run in the current module PowerShell interpreter. +Both the remote PowerShell and the one specified by executable must be running on PowerShell v5.1 or newer. +Setting this value may change the values returned in the |
+
| + | Parameters to pass into the script as key value pairs. +The key corresponds to the parameter name and the value is the value for that parameter. + |
+
| + | A path or path filter pattern; when the referenced path does not exist on the target host, the task will be skipped. + |
+
| + | The PowerShell script to run. + |
+
| + | Parameters to pass into the script as a SecureString or PSCredential. +Each sensitive value will be marked with The value suboption can be used to create a SecureString value while username and password can be used to create a PSCredential value. + |
+
| + | The name of the parameter to pass this value to. + |
+
| + | The This is mutually exclusive with value and must be set when username is provided. + |
+
| + | The This is mutually exclusive with value. +This value is NOT added to the |
+
| + | The string to pass as a SecureString of the parameter specified by name. +This is mutually exclusive with username and password. + |
+
Notes
+
+
+Note
+-
+
The module is set as failed when a terminating exception is throw, or
error_action=stopand a normal error record is raised.
+The output values are processed using a custom filter and while it mostly matches the
ConvertTo-Jsonresult the following value types are different.
+DateTimewill be an ISO 8601 string in UTC,DateTimeOffsetwill have the offset as specified by the value.
+Enumwill contain a dictionary withType,String,Valuebeing the type name, string representation and raw integer value respectively.
+Typewill contain a dictionary withName,FullName,AssemblyQualifiedName,BaseTypebeing the type name, the type name including the namespace, the full assembly name the type was defined in and the base type it derives from.
+The script has access to the
$Ansiblevariable where it can setResult,Changed,Failed,Diff, or accessTmpdir.
+$Ansible.Resultis a value that is returned back to the controller as is.
+$Ansible.Diffwas added in the1.12.0release ofansible.windowsand is a dictionary that is set to the diff result that can be interepreted by Ansible.
+$Ansible.Changedcan be set totrueorfalseto reflect whether the module made a change or not. By default this is set totrue.
+$Ansible.Failedcan be set totrueif the script wants to return the failure back to the controller.
+$Ansible.Tmpdiris the path to a temporary directory to use as a scratch location that is cleaned up after the module has finished.
+$Ansible.Verbosityreveals Ansible’s verbosity level for this play. Allows the script to set VerbosePreference/DebugPreference based on verbosity. Added in1.9.0.
+Any host/console direct output like
Write-Hostor[Console]::WriteLineis not considered an output object, they are returned as a string in host_out and host_err.
+Any output stream object is instead returned as a list in output. This is true not only for
Write-Outputand its built-in aliasecho, but also for implicit output; i.e.Write-Output "foo"and"foo"give the same result.
+The module will skip running the script when in check mode unless the script defines
[CmdletBinding(SupportsShouldProcess]).
+
See Also
+
+
+See also
+-
+
- ansible.windows.win_command
Executes a command on a remote Windows node.
+
+- ansible.windows.win_shell
Execute shell commands on target hosts.
+
+
Examples
+- name: Run basic PowerShell script
+ ansible.windows.win_powershell:
+ script: |
+ echo "Hello World"
+
+- name: Run PowerShell script with parameters
+ ansible.windows.win_powershell:
+ script: |
+ [CmdletBinding()]
+ param (
+ [String]
+ $Path,
+
+ [Switch]
+ $Force
+ )
+
+ New-Item -Path $Path -ItemType Directory -Force:$Force
+ parameters:
+ Path: C:\temp
+ Force: true
+
+- name: Run PowerShell script that modifies the module changed result
+ ansible.windows.win_powershell:
+ script: |
+ if (Get-Service -Name test -ErrorAction SilentlyContinue) {
+ Remove-Service -Name test
+ }
+ else {
+ $Ansible.Changed = $false
+ }
+
+- name: Run PowerShell script in PowerShell 7
+ ansible.windows.win_powershell:
+ script: |
+ $PSVersionTable.PSVersion.Major
+ executable: pwsh.exe
+ arguments:
+ - -ExecutionPolicy
+ - ByPass
+ register: pwsh_output
+ failed_when:
+ - pwsh_output.output[0] != 7
+
+- name: Run code in check mode
+ ansible.windows.win_powershell:
+ script: |
+ [CmdletBinding(SupportsShouldProcess)]
+ param ()
+
+ # Use $Ansible to detect check mode
+ if ($Ansible.CheckMode) {
+ echo 'running in check mode'
+ }
+ else {
+ echo 'running in normal mode'
+ }
+
+ # Use builtin ShouldProcess (-WhatIf)
+ if ($PSCmdlet.ShouldProcess('target')) {
+ echo 'also running in normal mode'
+ }
+ else {
+ echo 'also running in check mode'
+ }
+ check_mode: true
+
+- name: Return a failure back to Ansible
+ ansible.windows.win_powershell:
+ script: |
+ if (Test-Path C:\bad.file) {
+ $Ansible.Failed = $true
+ }
+
+- name: Define when the script made a change or not
+ ansible.windows.win_powershell:
+ script: |
+ if ((Get-Item WSMan:\localhost\Service\Auth\Basic).Value -eq 'true') {
+ Set-Item WSMan:\localhost\Service\Auth\Basic -Value false
+ }
+ else {
+ $Ansible.Changed = $true
+ }
+
+- name: Define when to enable Verbose/Debug output
+ ansible.windows.win_powershell:
+ script: |
+ if ($Ansible.Verbosity -ge 3) {
+ $VerbosePreference = "Continue"
+ }
+ if ($Ansible.Verbosity -eq 5) {
+ $DebugPreference = "Continue"
+ }
+ Write-Output "Hello World!"
+ Write-Verbose "Hello World!"
+ Write-Debug "Hello World!"
+
+- name: Set sensitive parameter value as SecureString parameter
+ ansible.windows.win_powershell:
+ script: |
+ param(
+ [string]$Uri,
+ [SecureString]$Token
+ )
+
+ Invoke-WebRequest -Uri $Uri -Token $Token
+ parameters:
+ Uri: foo
+ sensitive_parameters:
+ - name: Token
+ value: '{{ sensitive_value }}'
+
+- name: Set credential parameter
+ ansible.windows.win_powershell:
+ script: |
+ param(
+ [string]$Uri,
+ [PSCredential]$Credential
+ )
+
+ Invoke-WebRequest -Uri $Uri -Credential $Credential
+ parameters:
+ Uri: foo
+ sensitive_parameters:
+ - name: Credential
+ username: CredUserName
+ password: '{{ sensitive_value }}'
+Return Values
+Common return values are documented here, the following are the fields unique to this module:
+Key |
+Description |
+
|---|---|
| + | A list of warning messages created by the script. +Debug messages only appear when Returned: always +Sample: |
+
| + | A list of error records created by the script. +Returned: always + |
+
| + | More information about the error record. +Returned: success + |
+
| + | Description of the operation which encountered the error. +Returned: always +Sample: |
+
| + | The category name of the error record. +Returned: always +Sample: |
+
| + | The integer representation of the category. +Returned: always +Sample: |
+
| + | Description of the error. +Returned: always +Sample: |
+
| + | Description of the target object. +Can be an empty string if no target was specified. +Returned: always +Sample: |
+
| + | Description of the type of the target object. +Can be an empty string if no target object was specified. +Returned: always +Sample: |
+
| + | Additional details about an ErrorRecord. +Can be null if there are not additional details. +Returned: success + |
+
| + | Message for the error record. +Returned: always +Sample: |
+
| + | Recommended action in the even that this error occurs. +This is empty unless the code which generates the error adds this explicitly. +Returned: always +Sample: |
+
| + | Details about the exception behind the error record. +Returned: success + |
+
| + | A link to the help details for the exception. +May not be set as it’s dependent on whether the .NET exception class provides this info. +Returned: always +Sample: |
+
| + | The signed integer assigned to this exception. +May not be set as it’s dependent on whether the .NET exception class provides this info. +Returned: always +Sample: |
+
| + | The inner exception details if there is one present. +The dict contains the same keys as a normal exception. +Returned: always + |
+
| + | The exception message. +Returned: always +Sample: |
+
| + | Name of the application or object that causes the error. +This may be an empty string as it’s dependent on the code that raises the exception. +Returned: always +Sample: |
+
| + | The full .NET type of the Exception class. +Returned: always +Sample: |
+
| + | The unique identifier for the error condition +May be null if no id was specified when the record was created. +Returned: always +Sample: |
+
| + | The formatted error record message as typically seen in a PowerShell console. +Returned: always +Sample: |
+
| + | The status of the pipeline when this record was created. +The values are 0 index based. +Each element entry represents the command index in a pipeline statement. +The value of each element represents the pipeline input idx in that command. +For Example Returned: always +Sample: |
+
| + | The script stack trace for the error record. +Returned: always +Sample: |
+
| + | The object which the error occured. +May be null if no object was specified when the record was created. +Type type of this object depends on the error record itself. +If the value is a complex type, it will follow the Returned: always +Sample: |
+
| + | The strings written to the host error output, typically the stderr. +This is not the same as objects sent to the error stream in PowerShell. +Returned: always +Sample: |
+
| + | The strings written to the host output, typically the stdout. +This is not the same as objects sent to the output stream in PowerShell. +Returned: always +Sample: |
+
| + | A list of information records created by the script. +The information stream was only added in PowerShell v5, older versions will always have an empty list as a value. +Returned: always + |
+
| + | Message data associated with the record. +The value here can be of any type. +Returned: always +Sample: |
+
| + | The source of the record. +Returned: always +Sample: |
+
| + | A list of tags associated with the record. +Returned: always +Sample: |
+
| + | The time the record was generated. +This is the time in UTC as an ISO 8601 formatted string. +Returned: always +Sample: |
+
| + | A list containing all the objects outputted by the script. +The list elements can be anything as it is based on what was ran. +Returned: always +Sample: |
+
| + | The values that were set by Defaults to an empty dict but can be set to anything by the script. +Returned: always +Sample: |
+
| + | A list of warning messages created by the script. +Verbose messages only appear when Returned: always +Sample: |
+
| + | A list of warning messages created by the script. +Warning messages only appear when Returned: always +Sample: |
+
Collection links
+ +
+
+
+
+
+ -
+
- Blog +
- Ansible community forum +
- Documentation +
+ Ansible Collections Documentation
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/tag/2.4.0/collections/ansible/windows/win_reg_stat_module.html b/tag/2.4.0/collections/ansible/windows/win_reg_stat_module.html
new file mode 100644
index 00000000..0792b830
--- /dev/null
+++ b/tag/2.4.0/collections/ansible/windows/win_reg_stat_module.html
@@ -0,0 +1,360 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ ansible.windows.win_reboot module – Reboot a windows machine
+
+
+
+Note
+This module is part of the ansible.windows collection (version 2.4.0).
+It is not included in ansible-core.
+To check whether it is installed, run ansible-galaxy collection list.
To install it, use: ansible-galaxy collection install ansible.windows.
To use it in a playbook, specify: ansible.windows.win_reboot.
Synopsis
+-
+
Unconditionally reboot a Windows machine, wait for it to go down, come back up, and respond to commands.
+For non-Windows targets, use the ansible.builtin.reboot module instead.
+
+
+Note
+This module has a corresponding action plugin.
+Parameters
+Parameter |
+Comments |
+
|---|---|
| + | Command to run that returns a unique string indicating the last time the system was booted. +Setting this to a command that has different output each time it is run will cause the task to fail. +Default: |
+
| + | Maximum seconds to wait for a single successful TCP connection to the WinRM endpoint before trying again. +Default: |
+
| + | Message to display to users. +Default: |
+
| + | Seconds to wait after the reboot command was successful before attempting to validate the system rebooted successfully. +This is useful if you want wait for something to settle despite your connection already working. +Default: |
+
| + | Seconds to wait before reboot. Passed as a parameter to the reboot command. +The minimum version is Default: |
+
| + | Maximum seconds to wait for machine to re-appear on the network and respond to a test command. +This timeout is evaluated separately for both reboot verification and test command success so maximum clock time is actually twice this value. +Default: |
+
| + | Command to expect success for to determine the machine is ready for management. +By default this test command is a custom one to detect when the Windows Logon screen is up and ready to accept credentials. Using a custom command will replace this behaviour and just run the command specified. + |
+
Notes
+
+
+Note
+-
+
If a shutdown was already scheduled on the system, ansible.windows.win_reboot will abort the scheduled shutdown and enforce its own shutdown.
+Beware that when ansible.windows.win_reboot returns, the Windows system may not have settled yet and some base services could be in limbo. This can result in unexpected behavior. Check the examples for ways to mitigate this. This has been slightly mitigated in the
1.6.0release ofansible.windowsbut it is not guranteed to always wait until the logon prompt is shown.
+The connection user must have the
SeRemoteShutdownPrivilegeprivilege enabled, see https://docs.microsoft.com/en-us/windows/security/threat-protection/security-policy-settings/force-shutdown-from-a-remote-system for more information.
+This module is equivalent to using the /f forced option for reboot on a windows host
+
See Also
+
+
+See also
+-
+
- ansible.builtin.reboot
The official documentation on the ansible.builtin.reboot module.
+
+
Examples
+- name: Reboot the machine with all defaults
+ ansible.windows.win_reboot:
+
+- name: Reboot a slow machine that might have lots of updates to apply
+ ansible.windows.win_reboot:
+ reboot_timeout: 3600
+
+# Install a Windows feature and reboot if necessary
+- name: Install IIS Web-Server
+ ansible.windows.win_feature:
+ name: Web-Server
+ register: iis_install
+
+- name: Reboot when Web-Server feature requires it
+ ansible.windows.win_reboot:
+ when: iis_install.reboot_required
+
+# One way to ensure the system is reliable, is to set WinRM to a delayed startup
+- name: Ensure WinRM starts when the system has settled and is ready to work reliably
+ ansible.windows.win_service:
+ name: WinRM
+ start_mode: delayed
+
+# Additionally, you can add a delay before running the next task
+- name: Reboot a machine that takes time to settle after being booted
+ ansible.windows.win_reboot:
+ post_reboot_delay: 120
+
+# Or you can make win_reboot validate exactly what you need to work before running the next task
+- name: Validate that the netlogon service has started, before running the next task
+ ansible.windows.win_reboot:
+ test_command: 'exit (Get-Service -Name Netlogon).Status -ne "Running"'
+Return Values
+Common return values are documented here, the following are the fields unique to this module:
+Key |
+Description |
+
|---|---|
| + | The number of seconds that elapsed waiting for the system to be rebooted. +Returned: always +Sample: |
+
| + | True if the machine was rebooted. +Returned: always +Sample: |
+
Collection links
+ +
+
+
+
+
+ -
+
- Blog +
- Ansible community forum +
- Documentation +
+ Ansible Collections Documentation
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/tag/2.4.0/collections/ansible/windows/win_regedit_module.html b/tag/2.4.0/collections/ansible/windows/win_regedit_module.html
new file mode 100644
index 00000000..f9ebf441
--- /dev/null
+++ b/tag/2.4.0/collections/ansible/windows/win_regedit_module.html
@@ -0,0 +1,461 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ ansible.windows.win_reg_stat module – Get information about Windows registry keys
+
+
+
+Note
+This module is part of the ansible.windows collection (version 2.4.0).
+It is not included in ansible-core.
+To check whether it is installed, run ansible-galaxy collection list.
To install it, use: ansible-galaxy collection install ansible.windows.
To use it in a playbook, specify: ansible.windows.win_reg_stat.
Synopsis
+-
+
Like ansible.windows.win_file, ansible.windows.win_reg_stat will return whether the key/property exists.
+It also returns the sub keys and properties of the key specified.
+If specifying a property name through property, it will return the information specific for that property.
+
Parameters
+Parameter |
+Comments |
+
|---|---|
| + | The registry property name to get information for, the return json will not include the sub_keys and properties entries for the key specified. +Set to an empty string to target the registry key’s |
+
| + | The full registry key path including the hive to search for. + |
+
Notes
+
+
+Note
+-
+
The
propertiesreturn value will contain an empty string key""that refers to the key’sDefaultvalue. If the value has not been set then this key is not returned.
+
See Also
+
+
+See also
+-
+
- ansible.windows.win_regedit
Add, change, or remove registry keys and values.
+
+- community.windows.win_regmerge
The official documentation on the community.windows.win_regmerge module.
+
+
Examples
+- name: Obtain information about a registry key using short form
+ ansible.windows.win_reg_stat:
+ path: HKLM:\SOFTWARE\Microsoft\Windows\CurrentVersion
+ register: current_version
+
+- name: Obtain information about a registry key property
+ ansible.windows.win_reg_stat:
+ path: HKLM:\SOFTWARE\Microsoft\Windows\CurrentVersion
+ name: CommonFilesDir
+ register: common_files_dir
+
+- name: Obtain the registry key's (Default) property
+ ansible.windows.win_reg_stat:
+ path: HKLM:\SOFTWARE\Microsoft\Windows\CurrentVersion
+ name: ''
+ register: current_version_default
+Return Values
+Common return values are documented here, the following are the fields unique to this module:
+Key |
+Description |
+
|---|---|
| + | Whether anything was changed. +Returned: always +Sample: |
+
| + | States whether the registry key/property exists. +Returned: success and path/property exists +Sample: |
+
| + | A dictionary containing all the properties and their values in the registry key. +Returned: success, path exists and property not specified +Sample: |
+
| + | Returns the raw value of the registry property, REG_EXPAND_SZ has no string expansion, REG_BINARY or REG_NONE is in hex 0x format. REG_NONE, this value is a hex string in the 0x format. +Returned: success, path/property exists and property specified +Sample: |
+
| + | A list of all the sub keys of the key specified. +Returned: success, path exists and property not specified +Sample: |
+
| + | The property type. +Returned: success, path/property exists and property specified +Sample: |
+
| + | The value of the property. +Returned: success, path/property exists and property specified +Sample: |
+
Collection links
+ +
+
+
+
+
+ -
+
- Blog +
- Ansible community forum +
- Documentation +
+ Ansible Collections Documentation
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/tag/2.4.0/collections/ansible/windows/win_service_info_module.html b/tag/2.4.0/collections/ansible/windows/win_service_info_module.html
new file mode 100644
index 00000000..295dc602
--- /dev/null
+++ b/tag/2.4.0/collections/ansible/windows/win_service_info_module.html
@@ -0,0 +1,664 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ ansible.windows.win_regedit module – Add, change, or remove registry keys and values
+
+
+
+Note
+This module is part of the ansible.windows collection (version 2.4.0).
+It is not included in ansible-core.
+To check whether it is installed, run ansible-galaxy collection list.
To install it, use: ansible-galaxy collection install ansible.windows.
To use it in a playbook, specify: ansible.windows.win_regedit.
Synopsis
+-
+
Add, modify or remove registry keys and values.
+More information about the windows registry from Wikipedia https://en.wikipedia.org/wiki/Windows_Registry.
+
Parameters
+Parameter |
+Comments |
+
|---|---|
| + | Value of the registry entry If not specified then the value for the property will be null for the corresponding Binary and None data should be expressed in a yaml byte array or as comma separated hex values. +An easy way to generate this is to run In the exported file, binary value will look like DWORD and QWORD values should either be represented as a decimal number or a hex value. +Multistring values should be passed in as a list. +See the examples for more details on how to format this data. + |
+
| + | When If Choices: +
|
+
| + | A path to a hive key like C:\Users\Default\NTUSER.DAT to load in the registry. +This hive is loaded under the HKLM:\ANSIBLE key which can then be used in name like any other path. +This can be used to load the default user profile registry hive or any other hive saved as a file. +Using this function requires the user to have the |
+
| + | Name of the registry entry in the above If not provided, or empty then the ‘(Default)’ property for the key will be used. + |
+
| + | Name of the registry path. +Should be in one of the following registry hives: HKCC, HKCR, HKCU, HKLM, HKU. + |
+
| + | The state of the registry entry. +Choices: +
|
+
| + | The registry value data type. +Choices: +
|
+
Notes
+
+
+Note
+-
+
Check-mode
-C/--checkand diff output-D/--diffare supported, so that you can test every change against the active configuration before applying changes.
+Beware that some registry hives (
HKEY_USERSin particular) do not allow to create new registry paths in the root folder.
+
See Also
+
+
+See also
+-
+
- ansible.windows.win_reg_stat
Get information about Windows registry keys.
+
+- community.windows.win_regmerge
The official documentation on the community.windows.win_regmerge module.
+
+
Examples
+- name: Create registry path MyCompany
+ ansible.windows.win_regedit:
+ path: HKCU:\Software\MyCompany
+
+- name: Add or update registry path MyCompany, with entry 'hello', and containing 'world'
+ ansible.windows.win_regedit:
+ path: HKCU:\Software\MyCompany
+ name: hello
+ data: world
+
+- name: Add or update registry path MyCompany, with dword entry 'hello', and containing 1337 as the decimal value
+ ansible.windows.win_regedit:
+ path: HKCU:\Software\MyCompany
+ name: hello
+ data: 1337
+ type: dword
+
+- name: Add or update registry path MyCompany, with dword entry 'hello', and containing 0xff2500ae as the hex value
+ ansible.windows.win_regedit:
+ path: HKCU:\Software\MyCompany
+ name: hello
+ data: 0xff2500ae
+ type: dword
+
+- name: Add or update registry path MyCompany, with binary entry 'hello', and containing binary data in hex-string format
+ ansible.windows.win_regedit:
+ path: HKCU:\Software\MyCompany
+ name: hello
+ data: hex:be,ef,be,ef,be,ef,be,ef,be,ef
+ type: binary
+
+- name: Add or update registry path MyCompany, with binary entry 'hello', and containing binary data in yaml format
+ ansible.windows.win_regedit:
+ path: HKCU:\Software\MyCompany
+ name: hello
+ data: [0xbe, 0xef, 0xbe, 0xef, 0xbe, 0xef, 0xbe, 0xef, 0xbe, 0xef]
+ type: binary
+
+- name: Add or update registry path MyCompany, with expand string entry 'hello'
+ ansible.windows.win_regedit:
+ path: HKCU:\Software\MyCompany
+ name: hello
+ data: '%appdata%\local'
+ type: expandstring
+
+- name: Add or update registry path MyCompany, with multi string entry 'hello'
+ ansible.windows.win_regedit:
+ path: HKCU:\Software\MyCompany
+ name: hello
+ data: ['hello', 'world']
+ type: multistring
+
+- name: Disable keyboard layout hotkey for all users (changes existing)
+ ansible.windows.win_regedit:
+ path: HKU:\.DEFAULT\Keyboard Layout\Toggle
+ name: Layout Hotkey
+ data: 3
+ type: dword
+
+- name: Disable language hotkey for current users (adds new)
+ ansible.windows.win_regedit:
+ path: HKCU:\Keyboard Layout\Toggle
+ name: Language Hotkey
+ data: 3
+ type: dword
+
+- name: Remove registry path MyCompany (including all entries it contains)
+ ansible.windows.win_regedit:
+ path: HKCU:\Software\MyCompany
+ state: absent
+ delete_key: true
+
+- name: Clear the existing (Default) entry at path MyCompany
+ ansible.windows.win_regedit:
+ path: HKCU:\Software\MyCompany
+ state: absent
+ delete_key: false
+
+- name: Remove entry 'hello' from registry path MyCompany
+ ansible.windows.win_regedit:
+ path: HKCU:\Software\MyCompany
+ name: hello
+ state: absent
+
+- name: Change default mouse trailing settings for new users
+ ansible.windows.win_regedit:
+ path: HKLM:\ANSIBLE\Control Panel\Mouse
+ name: MouseTrails
+ data: 10
+ type: string
+ state: present
+ hive: C:\Users\Default\NTUSER.dat
+Return Values
+Common return values are documented here, the following are the fields unique to this module:
+Key |
+Description |
+
|---|---|
| + | Whether this invocation changed the data in the registry value. +Returned: success +Sample: |
+
| + | Whether this invocation changed the datatype of the registry value. +Returned: success +Sample: |
+
Collection links
+ +
+
+
+
+
+ -
+
- Blog +
- Ansible community forum +
- Documentation +
+ Ansible Collections Documentation
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/tag/2.4.0/collections/ansible/windows/win_service_module.html b/tag/2.4.0/collections/ansible/windows/win_service_module.html
new file mode 100644
index 00000000..e1ba2727
--- /dev/null
+++ b/tag/2.4.0/collections/ansible/windows/win_service_module.html
@@ -0,0 +1,844 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ ansible.windows.win_service_info module – Gather information about Windows services
+
+
+
+Note
+This module is part of the ansible.windows collection (version 2.4.0).
+It is not included in ansible-core.
+To check whether it is installed, run ansible-galaxy collection list.
To install it, use: ansible-galaxy collection install ansible.windows.
To use it in a playbook, specify: ansible.windows.win_service_info.
Synopsis
+-
+
Gather information about all or a specific installed Windows service(s).
+
Parameters
+Parameter |
+Comments |
+
|---|---|
| + | If specified, this is used to match the Can be a wildcard to match multiple services but the wildcard will only be matched on the If omitted then all services will returned. + |
+
See Also
+
+
+See also
+-
+
- ansible.windows.win_service
Manage and query Windows services.
+
+
Examples
+- name: Get info for all installed services
+ ansible.windows.win_service_info:
+ register: service_info
+
+- name: Get info for a single service
+ ansible.windows.win_service_info:
+ name: WinRM
+ register: service_info
+
+- name: Get info for a service using its display name
+ ansible.windows.win_service_info:
+ name: Windows Remote Management (WS-Management)
+
+- name: Find all services that start with 'win'
+ ansible.windows.win_service_info:
+ name: win*
+Return Values
+Common return values are documented here, the following are the fields unique to this module:
+Key |
+Description |
+
|---|---|
| + | Whether any services were found based on the criteria specified. +Returned: always +Sample: |
+
| + | A list of service(s) that were found based on the criteria. +Will be an empty list if no services were found. +Returned: always + |
+
| + | A check-point value that the service increments periodically to report its progress. +Returned: success +Sample: |
+
| + | A list of controls that the service can accept. +Common controls are Returned: success +Sample: |
+
| + | A list of services by their Returned: success +Sample: |
+
| + | A list of services by their Returned: success +Sample: |
+
| + | The description of the service. +Returned: success +Sample: |
+
| + | Whether the service can interact with the desktop, only valid for services running as Returned: success +Sample: |
+
| + | The display name to be used by SCM to identify the service. +Returned: success +Sample: |
+
| + | The action to take if a service fails to start. +Common values are Returned: success +Sample: |
+
| + | Controls when failure actions are fired based on how the service was stopped. +Returned: success +Sample: |
+
| + | A list of failure actions to run in the event of a failure. +Returned: success + |
+
| + | The time to wait, in milliseconds, before performing the specified action. +Returned: success +Sample: |
+
| + | The action that will be performed. +Common values are Returned: success +Sample: |
+
| + | The command line that will be run when a Returned: success +Sample: |
+
| + | The message to be broadcast to server users before rebooting when a Returned: success +Sample: |
+
| + | The time, in seconds, after which to reset the failure count to zero. +Returned: success +Sample: |
+
| + | The protection type of the service. +Common values are Returned: success +Sample: |
+
| + | The name of the load ordering group to which the service belongs. +Will be an empty string if it does not belong to any group. +Returned: success +Sample: |
+
| + | The name of the service. +Returned: success +Sample: |
+
| + | The path to the service binary and any arguments used when starting the service. +The binary part can be quoted to ensure any spaces in path are not treated as arguments. +Returned: success +Sample: |
+
| + | The preshutdown timeout out value in milliseconds. +Returned: success +Sample: |
+
| + | The node number for the preferred node. +This will be Returned: success +Sample: |
+
| + | The process identifier of the running service. +Returned: success +Sample: |
+
| + | A list of privileges that the service requires and will run with +Returned: success +Sample: |
+
| + | A service-specific error code that is set while the service is starting or stopping. +Returned: success +Sample: |
+
| + | Shows more information about the behaviour of a running service. +Currently the only flag that can be set is Returned: success +Sample: |
+
| + | The type of service. +Common types are Returned: success +Sample: |
+
| + | The behavior of how the service’s access token is generated and how to add the service SID to the token. +Common values are Returned: success +Sample: |
+
| + | When the service is set to start. +Common values are Returned: success +Sample: |
+
| + | The current running state of the service. +Common values are Returned: success +Sample: |
+
| + | A list of triggers defined for the service. +Returned: success + |
+
| + | The action to perform once triggered, can be Returned: success +Sample: |
+
| + | A list of trigger data items that contain trigger specific data. +A trigger can contain 0 or multiple data items. +Returned: success + |
+
| + | The trigger data item value. +Can be a string, list of string, int, or base64 string of binary data. +Returned: success +Sample: |
+
| + | The type of Common values are Returned: success +Sample: |
+
| + | The trigger event sub type that is specific to each Common values are Returned: success + |
+
| + | The guid which represents the trigger sub type. +Returned: success +Sample: |
+
| + | The trigger event type. +Common values are Returned: success +Sample: |
+
| + | The username used to run the service. +Can be null for user services and certain driver services. +Returned: success +Sample: |
+
| + | The estimated time in milliseconds required for a pending start, stop, pause,or continue operations. +Returned: success +Sample: |
+
| + | The error code returned from the service binary once it has stopped. +When set to Returned: success +Sample: |
+
Collection links
+ +
+
+
+
+
+ -
+
- Blog +
- Ansible community forum +
- Documentation +
+ Ansible Collections Documentation
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/tag/2.4.0/collections/ansible/windows/win_share_module.html b/tag/2.4.0/collections/ansible/windows/win_share_module.html
new file mode 100644
index 00000000..c7dd2fd1
--- /dev/null
+++ b/tag/2.4.0/collections/ansible/windows/win_share_module.html
@@ -0,0 +1,413 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ ansible.windows.win_service module – Manage and query Windows services
+
+
+
+Note
+This module is part of the ansible.windows collection (version 2.4.0).
+It is not included in ansible-core.
+To check whether it is installed, run ansible-galaxy collection list.
To install it, use: ansible-galaxy collection install ansible.windows.
To use it in a playbook, specify: ansible.windows.win_service.
Synopsis
+-
+
Manage and query Windows services.
+For non-Windows targets, use the ansible.builtin.service module instead.
+
Parameters
+Parameter |
+Comments |
+
|---|---|
| + | A list of service dependencies to set for this particular service. +This should be a list of service names and not the display name of the service. +This works by |
+
| + | Used in conjunction with Remove the dependencies to the existing dependencies. +Set the dependencies to only the values in the list replacing the existing dependencies. +Choices: +
|
+
| + | The description to set for the service. + |
+
| + | Whether to allow the service user to interact with the desktop. +This can only be set to This can only be set to Choices: +
|
+
| + | The display name to set for the service. + |
+
| + | The severity of the error and action token if the service fails to start. +A new service defaults to
Choices: +
|
+
| + | A list of failure actions the service controller should take on each failure of a service. +The service manager will run the actions from first to last defined until the service starts. If failure_reset_period_sec has been exceeded then the failure actions will restart from the beginning. +If all actions have been performed the the service manager will repeat the last service defined. +The existing actions will be replaced with the list defined in the task if there is a mismatch with any of them. +Set to an empty list to delete all failure actions on a service otherwise an omitted or null value preserves the existing actions on the service. + |
+
| + | The time to wait, in milliseconds, before performing the specified action. +Default: |
+
| + | The action to be performed. +
Choices: +
|
+
| + | Controls whether failure actions will be performed on non crash failures or not. +Choices: +
|
+
| + | The command to run for a Set to an empty string to remove the command. + |
+
| + | The message to be broadcast to users logged on the host for a Set to an empty string to remove the message. + |
+
| + | The time in seconds after which the failure action list resets back to the start of the list if there are no failures. +To set this value, failure_actions must have at least 1 action present. +Specify |
+
| + | If If Choices: +
|
+
| + | The name of the load ordering group of which this service is a member. +Specify an empty string to remove the existing load order group of a service. + |
+
| + | Name of the service. +If only the name parameter is specified, the module will report on whether the service exists or not without making any changes. + |
+
| + | The password to set the service to start as. +This and the If omitted then the password will continue to use the existing value password set. +If specifying |
+
| + | The path to the executable to set for the service. + |
+
| + | The time in which the service manager waits after sending a preshutdown notification to the service until it proceeds to continue with the other shutdown actions. + |
+
| + | A list of privileges the service must have when starting up. +When set the service will only have the privileges specified on its access token. +The username of the service must already have the privileges assigned. +The existing privileges will be replace with the list defined in the task if there is a mismatch with any of them. +Set to an empty list to remove all required privileges, otherwise an omitted or null value will keep the existing privileges. +See privilege text constants for a list of privilege constants that can be used. + |
+
| + | The type of service. +The default type of a new service is desktop_interact can only be set if the service type is Choices: +
|
+
| + | Used to define the behaviour of the service’s access token groups. +
Choices: +
|
+
| + | Set the startup type for the service. +A newly created service will default to Choices: +
|
+
| + | The desired state of the service. +
Only services that support the paused state can be paused, you can check the return value You can only pause a service that is already started. +A newly created service will default to Choices: +
|
+
| + | When set to Set to If username was specified and the service changed to that username then password will also be changed if specified. +The current default is Choices: +
|
+
| + | The username to set the service to start as. +Can also be set to A newly created service will default to If using a custom user account, it must have the Set to This can also be a gMSA in the form |
+
Notes
+
+
+Note
+-
+
This module historically returning information about the service in its return values. These should be avoided in favour of the ansible.windows.win_service_info module.
+Most of the options in this module are non-driver services that you can view in SCManager. While you can edit driver services, not all functionality may be available.
+The user running the module must have the following access rights on the service to be able to use it with this module -
SERVICE_CHANGE_CONFIG,SERVICE_ENUMERATE_DEPENDENTS,SERVICE_QUERY_CONFIG,SERVICE_QUERY_STATUS.
+Changing the state or removing the service will also require futher rights depending on what needs to be done.
+
See Also
+
+
+See also
+-
+
- ansible.builtin.service
The official documentation on the ansible.builtin.service module.
+
+- community.windows.win_nssm
The official documentation on the community.windows.win_nssm module.
+
+- ansible.windows.win_service_info
Gather information about Windows services.
+
+- ansible.windows.win_user_right
Manage Windows User Rights.
+
+
Examples
+- name: Restart a service
+ ansible.windows.win_service:
+ name: spooler
+ state: restarted
+
+- name: Set service startup mode to auto and ensure it is started
+ ansible.windows.win_service:
+ name: spooler
+ start_mode: auto
+ state: started
+
+- name: Pause a service
+ ansible.windows.win_service:
+ name: Netlogon
+ state: paused
+
+- name: Ensure that WinRM is started when the system has settled
+ ansible.windows.win_service:
+ name: WinRM
+ start_mode: delayed
+
+# A new service will also default to the following values:
+# - username: LocalSystem
+# - state: stopped
+# - start_mode: auto
+- name: Create a new service
+ ansible.windows.win_service:
+ name: service name
+ path: C:\temp\test.exe
+
+- name: Create a new service with extra details
+ ansible.windows.win_service:
+ name: service name
+ path: C:\temp\test.exe
+ display_name: Service Name
+ description: A test service description
+
+- name: Remove a service
+ ansible.windows.win_service:
+ name: service name
+ state: absent
+
+# This is required to be set for non-service accounts that need to run as a service
+- name: Grant domain account the SeServiceLogonRight user right
+ ansible.windows.win_user_right:
+ name: SeServiceLogonRight
+ users:
+ - DOMAIN\User
+ action: add
+
+- name: Set the log on user to a domain account
+ ansible.windows.win_service:
+ name: service name
+ state: restarted
+ username: DOMAIN\User
+ password: Password
+
+- name: Set the log on user to a local account
+ ansible.windows.win_service:
+ name: service name
+ state: restarted
+ username: .\Administrator
+ password: Password
+
+- name: Set the log on user to Local System
+ ansible.windows.win_service:
+ name: service name
+ state: restarted
+ username: SYSTEM
+
+- name: Set the log on user to Local System and allow it to interact with the desktop
+ ansible.windows.win_service:
+ name: service name
+ state: restarted
+ username: SYSTEM
+ desktop_interact: true
+
+- name: Set the log on user to Network Service
+ ansible.windows.win_service:
+ name: service name
+ state: restarted
+ username: NT AUTHORITY\NetworkService
+
+- name: Set the log on user to Local Service
+ ansible.windows.win_service:
+ name: service name
+ state: restarted
+ username: NT AUTHORITY\LocalService
+
+- name: Set the log on user as the services' virtual account
+ ansible.windows.win_service:
+ name: service name
+ username: NT SERVICE\service name
+
+- name: Set the log on user as a gMSA
+ ansible.windows.win_service:
+ name: service name
+ username: DOMAIN\gMSA$ # The end $ is important and should be set for all gMSA
+
+- name: Set dependencies to ones only in the list
+ ansible.windows.win_service:
+ name: service name
+ dependencies: [service1, service2]
+
+- name: Add dependencies to existing dependencies
+ ansible.windows.win_service:
+ name: service name
+ dependencies: [service1, service2]
+ dependency_action: add
+
+- name: Remove dependencies from existing dependencies
+ ansible.windows.win_service:
+ name: service name
+ dependencies:
+ - service1
+ - service2
+ dependency_action: remove
+
+- name: Set required privileges for a service
+ ansible.windows.win_service:
+ name: service name
+ username: NT SERVICE\LocalService
+ required_privileges:
+ - SeBackupPrivilege
+ - SeRestorePrivilege
+
+- name: Remove all required privileges for a service
+ ansible.windows.win_service:
+ name: service name
+ username: NT SERVICE\LocalService
+ required_privileges: []
+
+- name: Set failure actions for a service with no reset period
+ ansible.windows.win_service:
+ name: service name
+ failure_actions:
+ - type: restart
+ - type: run_command
+ delay_ms: 1000
+ - type: restart
+ delay_ms: 5000
+ - type: reboot
+ failure_command: C:\Windows\System32\cmd.exe /c mkdir C:\temp
+ failure_reboot_msg: Restarting host because service name has failed
+ failure_reset_period_sec: '0xFFFFFFFF'
+
+- name: Set only 1 failure action without a repeat of the last action
+ ansible.windows.win_service:
+ name: service name
+ failure_actions:
+ - type: restart
+ delay_ms: 5000
+ - type: none
+
+- name: Remove failure action information
+ ansible.windows.win_service:
+ name: service name
+ failure_actions: []
+ failure_command: '' # removes the existing command
+ failure_reboot_msg: '' # removes the existing reboot msg
+Return Values
+Common return values are documented here, the following are the fields unique to this module:
+Key |
+Description |
+
|---|---|
| + | Whether the service can be paused and unpaused. +Returned: success and service exists +Sample: |
+
| + | A list of services that depend on this service. +Returned: success and service exists +Sample: |
+
| + | A list of services that is depended by this service. +Returned: success and service exists +Sample: |
+
| + | The description of the service. +Returned: success and service exists +Sample: |
+
| + | Whether the current user is allowed to interact with the desktop. +Returned: success and service exists +Sample: |
+
| + | The display name of the installed service. +Returned: success and service exists +Sample: |
+
| + | Whether the service exists or not. +Returned: success +Sample: |
+
| + | The service name or id of the service. +Returned: success and service exists +Sample: |
+
| + | The path to the service executable. +Returned: success and service exists +Sample: |
+
| + | The startup type of the service. +Returned: success and service exists +Sample: |
+
| + | The current running status of the service. +Returned: success and service exists +Sample: |
+
| + | The username that runs the service. +Returned: success and service exists +Sample: |
+
Collection links
+ +
+
+
+
+
+ -
+
- Blog +
- Ansible community forum +
- Documentation +
+ Ansible Collections Documentation
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/tag/2.4.0/collections/ansible/windows/win_shell_module.html b/tag/2.4.0/collections/ansible/windows/win_shell_module.html
new file mode 100644
index 00000000..9e3f728d
--- /dev/null
+++ b/tag/2.4.0/collections/ansible/windows/win_shell_module.html
@@ -0,0 +1,454 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ -
+
- Blog +
- Ansible community forum +
- Documentation +
+ Ansible Collections Documentation
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/tag/2.4.0/collections/ansible/windows/win_stat_module.html b/tag/2.4.0/collections/ansible/windows/win_stat_module.html
new file mode 100644
index 00000000..c24f3495
--- /dev/null
+++ b/tag/2.4.0/collections/ansible/windows/win_stat_module.html
@@ -0,0 +1,588 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ ansible.windows.win_shell module – Execute shell commands on target hosts
+
+
+
+Note
+This module is part of the ansible.windows collection (version 2.4.0).
+It is not included in ansible-core.
+To check whether it is installed, run ansible-galaxy collection list.
To install it, use: ansible-galaxy collection install ansible.windows.
To use it in a playbook, specify: ansible.windows.win_shell.
Synopsis
+-
+
The ansible.windows.win_shell module takes the command name followed by a list of space-delimited arguments. It is similar to the ansible.windows.win_command module, but runs the command via a shell (defaults to PowerShell) on the target host.
+For non-Windows targets, use the ansible.builtin.shell module instead.
+
Parameters
+Parameter |
+Comments |
+
|---|---|
| + | Set the specified path as the current working directory before executing a command + |
+
| + | A path or path filter pattern; when the referenced path exists on the target host, the task will be skipped. + |
+
| + | Change the shell used to execute the command (eg, The target shell must accept a |
+
| + | The ansible.windows.win_shell module takes a free form command to run. +There is no parameter actually named ‘free form’. See the examples! + |
+
| + | Do not load the user profile before running a command. This is only valid when using PowerShell as the executable. +Choices: +
|
+
| + | This option overrides the encoding of stdout/stderr output. +You can use this option when you need to run a command which ignore the console’s codepage. +You should only need to use this option in very rare circumstances. +This value can be any valid encoding |
+
| + | A path or path filter pattern; when the referenced path does not exist on the target host, the task will be skipped. + |
+
| + | Set the stdin of the command directly to the specified value. + |
+
Notes
+
+
+Note
+-
+
If you want to run an executable securely and predictably, it may be better to use the ansible.windows.win_command module instead. Best practices when writing playbooks will follow the trend of using ansible.windows.win_command unless
win_shellis explicitly required. When running ad-hoc commands, use your best judgement.
+WinRM will not return from a command execution until all child processes created have exited. Thus, it is not possible to use ansible.windows.win_shell to spawn long-running child or background processes. Consider creating a Windows service for managing background processes. - Consider using ansible.windows.win_powershell if you want to capture the output from the PowerShell script as structured objects.
+
See Also
+
+
+See also
+-
+
- community.windows.psexec
The official documentation on the community.windows.psexec module.
+
+- ansible.builtin.raw
The official documentation on the ansible.builtin.raw module.
+
+- ansible.builtin.script
The official documentation on the ansible.builtin.script module.
+
+- ansible.builtin.shell
The official documentation on the ansible.builtin.shell module.
+
+- ansible.windows.win_command
Executes a command on a remote Windows node.
+
+- ansible.windows.win_powershell
Run PowerShell scripts.
+
+- community.windows.win_psexec
The official documentation on the community.windows.win_psexec module.
+
+
Examples
+- name: Execute a command in the remote shell, stdout goes to the specified file on the remote
+ ansible.windows.win_shell: C:\somescript.ps1 >> C:\somelog.txt
+
+- name: Change the working directory to somedir/ before executing the command
+ ansible.windows.win_shell: C:\somescript.ps1 >> C:\somelog.txt
+ args:
+ chdir: C:\somedir
+
+- name: Run a command with an idempotent check on what it creates, will only run when somedir/somelog.txt does not exist
+ ansible.windows.win_shell: C:\somescript.ps1 >> C:\somelog.txt
+ args:
+ chdir: C:\somedir
+ creates: C:\somelog.txt
+
+- name: Run a command under a non-Powershell interpreter (cmd in this case)
+ ansible.windows.win_shell: echo %HOMEDIR%
+ args:
+ executable: cmd
+ register: homedir_out
+
+- name: Run multi-lined shell commands
+ ansible.windows.win_shell: |
+ $value = Test-Path -Path C:\temp
+ if ($value) {
+ Remove-Item -Path C:\temp -Force
+ }
+ New-Item -Path C:\temp -ItemType Directory
+
+- name: Retrieve the input based on stdin
+ ansible.windows.win_shell: '$string = [Console]::In.ReadToEnd(); Write-Output $string.Trim()'
+ args:
+ stdin: Input message
+
+- name: Run a PowerShell script with -NoProfile
+ ansible.windows.win_shell: C:\somescript.ps1
+ args:
+ no_profile: true
+Return Values
+Common return values are documented here, the following are the fields unique to this module:
+Key |
+Description |
+
|---|---|
| + | The command executed by the task. +Returned: always +Sample: |
+
| + | The command execution delta time. +Returned: always +Sample: |
+
| + | The command execution end time. +Returned: always +Sample: |
+
| + | Changed. +Returned: always +Sample: |
+
| + | The command return code (0 means success). +Returned: always +Sample: |
+
| + | The command execution start time. +Returned: always +Sample: |
+
| + | The command standard error. +Returned: always +Sample: |
+
| + | The command standard output. +Returned: always +Sample: |
+
| + | The command standard output split in lines. +Returned: always +Sample: |
+
Collection links
+ +
+
+
+
+
+ -
+
- Blog +
- Ansible community forum +
- Documentation +
+ Ansible Collections Documentation
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/tag/2.4.0/collections/ansible/windows/win_tempfile_module.html b/tag/2.4.0/collections/ansible/windows/win_tempfile_module.html
new file mode 100644
index 00000000..53f4f624
--- /dev/null
+++ b/tag/2.4.0/collections/ansible/windows/win_tempfile_module.html
@@ -0,0 +1,303 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ ansible.windows.win_stat module – Get information about Windows files
+
+
+
+Note
+This module is part of the ansible.windows collection (version 2.4.0).
+It is not included in ansible-core.
+To check whether it is installed, run ansible-galaxy collection list.
To install it, use: ansible-galaxy collection install ansible.windows.
To use it in a playbook, specify: ansible.windows.win_stat.
Synopsis
+-
+
Returns information about a Windows file.
+For non-Windows targets, use the ansible.builtin.stat module instead.
+
Parameters
+Parameter |
+Comments |
+
|---|---|
| + | Algorithm to determine checksum of file. +Will throw an error if the host is unable to use specified algorithm. +Choices: +
|
+
| + | Whether to follow symlinks or junction points. +In the case of Choices: +
|
+
| + | Whether to return a checksum of the file (default sha1) +Choices: +
|
+
| + | Whether to return the size of a file or directory. +Choices: +
|
+
| + | The full path of the file/object to get the facts of; both forward and back slashes are accepted. + |
+
See Also
+
+
+See also
+-
+
- ansible.builtin.stat
The official documentation on the ansible.builtin.stat module.
+
+- ansible.windows.win_acl
Set file/directory/registry/certificate permissions for a system user or group.
+
+- ansible.windows.win_file
Creates, touches or removes files or directories.
+
+- ansible.windows.win_owner
Set owner.
+
+
Examples
+- name: Obtain information about a file
+ ansible.windows.win_stat:
+ path: C:\foo.ini
+ register: file_info
+
+- name: Obtain information about a folder
+ ansible.windows.win_stat:
+ path: C:\bar
+ register: folder_info
+
+- name: Get MD5 checksum of a file
+ ansible.windows.win_stat:
+ path: C:\foo.ini
+ get_checksum: true
+ checksum_algorithm: md5
+ register: md5_checksum
+
+- debug:
+ var: md5_checksum.stat.checksum
+
+- name: Get SHA1 checksum of file
+ ansible.windows.win_stat:
+ path: C:\foo.ini
+ get_checksum: true
+ register: sha1_checksum
+
+- debug:
+ var: sha1_checksum.stat.checksum
+
+- name: Get SHA256 checksum of file
+ ansible.windows.win_stat:
+ path: C:\foo.ini
+ get_checksum: true
+ checksum_algorithm: sha256
+ register: sha256_checksum
+
+- debug:
+ var: sha256_checksum.stat.checksum
+Return Values
+Common return values are documented here, the following are the fields unique to this module:
+Key |
+Description |
+
|---|---|
| + | Whether anything was changed +Returned: always +Sample: |
+
| + | dictionary containing all the stat data +Returned: success + |
+
| + | Attributes of the file at path in raw form. +Returned: success, path exists +Sample: |
+
| + | The checksum of a file based on checksum_algorithm specified. +Returned: success, path exist, path is a file, get_checksum == True checksum_algorithm specified is supported +Sample: |
+
| + | The create time of the file represented in seconds since epoch. +Returned: success, path exists +Sample: |
+
| + | If the path exists or not. +Returned: success +Sample: |
+
| + | The extension of the file at path. +Returned: success, path exists, path is a file +Sample: |
+
| + | The name of the file (without path). +Returned: success, path exists, path is a file +Sample: |
+
| + | List of other files pointing to the same file (hard links), excludes the current file. +Returned: success, path exists +Sample: |
+
| + | If the path is ready for archiving or not. +Returned: success, path exists +Sample: |
+
| + | If the path is a directory or not. +Returned: success, path exists +Sample: |
+
| + | If the path is hidden or not. +Returned: success, path exists +Sample: |
+
| + | If the path is a junction point or not. +Returned: success, path exists +Sample: |
+
| + | If the path is a symbolic link or not. +Returned: success, path exists +Sample: |
+
| + | If the path is read only or not. +Returned: success, path exists +Sample: |
+
| + | If the path is a regular file. +Returned: success, path exists +Sample: |
+
| + | If the path is shared or not. +Returned: success, path exists +Sample: |
+
| + | The last access time of the file represented in seconds since epoch. +Returned: success, path exists +Sample: |
+
| + | The last modification time of the file represented in seconds since epoch. +Returned: success, path exists +Sample: |
+
| + | Target of the symlink normalized for the remote filesystem. +Returned: success, path exists and the path is a symbolic link or junction point +Sample: |
+
| + | Target of the symlink. Note that relative paths remain relative. +Returned: success, path exists and the path is a symbolic link or junction point +Sample: |
+
| + | Number of links to the file (hard links). +Returned: success, path exists +Sample: |
+
| + | The owner of the file. +Returned: success, path exists +Sample: |
+
| + | The full absolute path to the file. +Returned: success, path exists, file exists +Sample: |
+
| + | The name of share if folder is shared. +Returned: success, path exists, file is a directory and isshared == True +Sample: |
+
| + | The size in bytes of a file or folder. +Returned: success, path exists, file is not a link, get_size == True +Sample: |
+
Collection links
+ +
+
+
+
+
+ -
+
- Blog +
- Ansible community forum +
- Documentation +
+ Ansible Collections Documentation
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/tag/2.4.0/collections/ansible/windows/win_template_module.html b/tag/2.4.0/collections/ansible/windows/win_template_module.html
new file mode 100644
index 00000000..10b21353
--- /dev/null
+++ b/tag/2.4.0/collections/ansible/windows/win_template_module.html
@@ -0,0 +1,424 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ ansible.windows.win_tempfile module – Creates temporary files and directories
+
+
+
+Note
+This module is part of the ansible.windows collection (version 2.4.0).
+It is not included in ansible-core.
+To check whether it is installed, run ansible-galaxy collection list.
To install it, use: ansible-galaxy collection install ansible.windows.
To use it in a playbook, specify: ansible.windows.win_tempfile.
Synopsis
+-
+
Creates temporary files and directories.
+For non-Windows targets, please use the ansible.builtin.tempfile module instead.
+
Parameters
+Parameter |
+Comments |
+
|---|---|
| + | Location where temporary file or directory should be created. +If path is not specified default system temporary directory (%TEMP%) will be used. +Default: |
+
| + | Prefix of file/directory name created by module. +Default: |
+
| + | Whether to create file or directory. +Choices: +
|
+
| + | Suffix of file/directory name created by module. + |
+
See Also
+
+
+See also
+-
+
- ansible.builtin.tempfile
The official documentation on the ansible.builtin.tempfile module.
+
+
Examples
+- name: Create temporary build directory
+ ansible.windows.win_tempfile:
+ state: directory
+ suffix: build
+
+- name: Create temporary file
+ ansible.windows.win_tempfile:
+ state: file
+ suffix: temp
+Return Values
+Common return values are documented here, the following are the fields unique to this module:
+Key |
+Description |
+
|---|---|
| + | The absolute path to the created file or directory. +Returned: success +Sample: |
+
Collection links
+ +
+
+
+
+
+ -
+
- Blog +
- Ansible community forum +
- Documentation +
+ Ansible Collections Documentation
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/tag/2.4.0/collections/ansible/windows/win_updates_module.html b/tag/2.4.0/collections/ansible/windows/win_updates_module.html
new file mode 100644
index 00000000..0e24a562
--- /dev/null
+++ b/tag/2.4.0/collections/ansible/windows/win_updates_module.html
@@ -0,0 +1,621 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ ansible.windows.win_template module – Template a file out to a remote server
+
+
+
+Note
+This module is part of the ansible.windows collection (version 2.4.0).
+It is not included in ansible-core.
+To check whether it is installed, run ansible-galaxy collection list.
To install it, use: ansible-galaxy collection install ansible.windows.
To use it in a playbook, specify: ansible.windows.win_template.
Synopsis
+-
+
Templates are processed by the Jinja2 templating language.
+Documentation on the template formatting can be found in the Template Designer Documentation.
+Additional variables listed below can be used in templates.
+ansible_managed(configurable via thedefaultssection ofansible.cfg) contains a string which can be used to describe the template name, host, modification time of the template file and the owner uid.
+template_hostcontains the node name of the template’s machine.
+template_uidis the numeric user id of the owner.
+template_pathis the path of the template.
+template_fullpathis the absolute path of the template.
+template_destpathis the path of the template on the remote system (added in 2.8).
+template_run_dateis the date that the template was rendered.
+
+
+Note
+This module has a corresponding action plugin.
+Parameters
+Parameter |
+Comments |
+
|---|---|
| + | Determine whether a backup should be created. +When set to Choices: +
|
+
| + | The string marking the end of a block. +Default: |
+
| + | The string marking the beginning of a block. +Default: |
+
| + | Location to render the template to on the remote machine. + |
+
| + | Determine when the file is being transferred if the destination already exists. +When set to When set to Choices: +
|
+
| + | Determine when leading spaces and tabs should be stripped. +When set to This functionality requires Jinja 2.7 or newer. +Choices: +
|
+
| + | Specify the newline sequence to use for templating files. +Choices: +
|
+
| + | Overrides the encoding used to write the template file defined by It defaults to The source template file must always be encoded using Default: |
+
| + | Path of a Jinja2 formatted template on the Ansible controller. +This can be a relative or an absolute path. +The file must be encoded with |
+
| + | Determine when newlines should be removed from blocks. +When set to Choices: +
|
+
| + | The string marking the end of a print statement. +Default: |
+
| + | The string marking the beginning of a print statement. +Default: |
+
Notes
+
+
+Note
+-
+
Including a string that uses a date in the template will result in the template being marked ‘changed’ each time.
+Also, you can override jinja2 settings by adding a special header to template file. i.e.
#jinja2:variable_start_string:'[%', variable_end_string:'%]', trim_blocks: Falsewhich changes the variable interpolation markers to[% var %]instead of{{ var }}. This is the best way to prevent evaluation of things that look like, but should not be Jinja2.
+Using raw/endraw in Jinja2 will not work as you expect because templates in Ansible are recursively evaluated.
+To find Byte Order Marks in files, use
Format-Hex <file> -Count 16on Windows, and useod -a -t x1 -N 16 <file>on Linux.
+Beware fetching files from windows machines when creating templates because certain tools, such as Powershell ISE, and regedit’s export facility add a Byte Order Mark as the first character of the file, which can cause tracebacks.
+You can use the ansible.windows.win_copy module with the
content:option if you prefer the template inline, as part of the playbook.
+For Linux you can use ansible.builtin.template which uses ‘\\n’ as
newline_sequenceby default.
+
See Also
+
+
+See also
+-
+
- ansible.windows.win_copy
Copies files to remote locations on windows hosts.
+
+- ansible.builtin.copy
The official documentation on the ansible.builtin.copy module.
+
+- ansible.builtin.template
The official documentation on the ansible.builtin.template module.
+
+
Examples
+- name: Create a file from a Jinja2 template
+ ansible.windows.win_template:
+ src: /mytemplates/file.conf.j2
+ dest: C:\Temp\file.conf
+
+- name: Create a Unix-style file from a Jinja2 template
+ ansible.windows.win_template:
+ src: unix/config.conf.j2
+ dest: C:\share\unix\config.conf
+ newline_sequence: '\n'
+ backup: true
+Return Values
+Common return values are documented here, the following are the fields unique to this module:
+Key |
+Description |
+
|---|---|
| + | Name of the backup file that was created. +Returned: if backup=true +Sample: |
+
Collection links
+ +
+
+
+
+
+ -
+
- Blog +
- Ansible community forum +
- Documentation +
+ Ansible Collections Documentation
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/tag/2.4.0/collections/ansible/windows/win_uri_module.html b/tag/2.4.0/collections/ansible/windows/win_uri_module.html
new file mode 100644
index 00000000..0ebc6a66
--- /dev/null
+++ b/tag/2.4.0/collections/ansible/windows/win_uri_module.html
@@ -0,0 +1,586 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ ansible.windows.win_updates module – Download and install Windows updates
+
+
+
+Note
+This module is part of the ansible.windows collection (version 2.4.0).
+It is not included in ansible-core.
+To check whether it is installed, run ansible-galaxy collection list.
To install it, use: ansible-galaxy collection install ansible.windows.
To use it in a playbook, specify: ansible.windows.win_updates.
Synopsis
+-
+
Searches, downloads, and installs Windows updates synchronously by automating the Windows Update client.
+
+
+Note
+This module has a corresponding action plugin.
+Parameters
+Parameter |
+Comments |
+
|---|---|
| + | Internal use only. +Choices: +
|
+
| + | Internal use only. + |
+
| + | A list of update titles or KB numbers that can be used to specify which updates are to be searched or installed. +If an available update does not match one of the entries, then it is skipped and not installed. +Each entry can either be the KB article or Update title as a regex according to the PowerShell regex rules. +The accept list is only validated on updates that were found based on category_names. It will not force the module to install an update if it was not in the category specified. + |
+
| + | A scalar or list of categories to install updates from. To get the list of categories, run the module with Some possible categories are Application, Connectors, Critical Updates, Definition Updates, Developer Kits, Feature Packs, Guidance, Security Updates, Service Packs, Tools, Update Rollups, Updates, and Upgrades. +Since Default: |
+
| + | If set, |
+
| + | Ansible will automatically reboot the remote host if it is required and continue to install updates after the reboot. +This can be used instead of using a ansible.windows.win_reboot task after this one and ensures all updates for that category is installed in one go. +Async does not work when Choices: +
|
+
| + | The time in seconds to wait until the host is back online from a reboot. +This is only used if Default: |
+
| + | A list of update titles or KB numbers that can be used to specify which updates are to be excluded from installation. +If an available update does match one of the entries, then it is skipped and not installed. +Each entry can either be the KB article or Update title as a regex according to the PowerShell regex rules. + |
+
| + | Defines the Windows Update source catalog. +
Choices: +
|
+
| + | Skip optional updates where the update has BrowseOnly set by Microsoft. +Microsoft documents show that BrowseOnly means that the update should not be installed automatically and appear as optional updates. +Choices: +
|
+
| + | Controls whether found updates are downloaded or installed or listed +This module also supports Ansible check mode, which has the same effect as setting state=searched +Choices: +
|
+
Notes
+
+
+Note
+-
+
ansible.windows.win_updates must be run by a user with membership in the local Administrators group.
+ansible.windows.win_updates will use the default update service configured for the machine (Windows Update, Microsoft Update, WSUS, etc).
+By default ansible.windows.win_updates does not manage reboots, but will signal when a reboot is required with the reboot_required return value. reboot can be used to reboot the host if required in the one task.
+ansible.windows.win_updates can take a significant amount of time to complete (hours, in some cases). Performance depends on many factors, including OS version, number of updates, system load, and update server load.
+Beware that just after ansible.windows.win_updates reboots the system, the Windows system may not have settled yet and some base services could be in limbo. This can result in unexpected behavior. Check the examples for ways to mitigate this.
+More information about PowerShell and how it handles RegEx strings can be found at https://technet.microsoft.com/en-us/library/2007.11.powershell.aspx.
+The current module doesn’t support Systems Center Configuration Manager (SCCM). See https://github.com/ansible-collections/ansible.windows/issues/194
+By default the
ansible.builtin.sshconnection plugin is configured to have no server timeout. As Windows Updates can restart the network adapter it is recommended to set-o ServerAliveInterval=30and disable control master in ansible_ssh_args to ensure the client can handle a network reset. See the examples showing one way this can be set.
+By default the module will start a background process using the Task Scheduler on Windows. If the Task Scheduler is unavailable, unreliable, or does not work, run the task with become.
+
See Also
+
+
+See also
+-
+
- chocolatey.chocolatey.win_chocolatey
The official documentation on the chocolatey.chocolatey.win_chocolatey module.
+
+- ansible.windows.win_feature
Installs and uninstalls Windows Features on Windows Server.
+
+- community.windows.win_hotfix
The official documentation on the community.windows.win_hotfix module.
+
+- ansible.windows.win_package
Installs/uninstalls an installable package.
+
+
Examples
+- name: Install all updates and reboot as many times as needed
+ ansible.windows.win_updates:
+ category_names: '*'
+ reboot: true
+
+- name: Set a server alive interval during update stage for the ssh connection plugin
+ ansible.windows.win_updates:
+ category_names: '*'
+ reboot: true
+ vars:
+ # This can be set in a few ways, see the ssh connection plugin for more
+ # information. ControlMaster should be disabled to ensure the new timeout
+ # value is applied for this connection instead of through the cached
+ # connection.
+ ansible_ssh_args: -o ControlMaster=no -o ServerAliveInterval=30
+
+- name: Install all security, critical, and rollup updates without a scheduled task
+ ansible.windows.win_updates:
+ category_names:
+ - SecurityUpdates
+ - CriticalUpdates
+ - UpdateRollups
+ become: true
+ become_method: runas
+ become_user: SYSTEM
+
+- name: Search-only, return list of found updates (if any), log to C:\ansible_wu.txt
+ ansible.windows.win_updates:
+ category_names: SecurityUpdates
+ state: searched
+ log_path: C:\ansible_wu.txt
+
+- name: Install all security updates with automatic reboots
+ ansible.windows.win_updates:
+ category_names:
+ - SecurityUpdates
+ reboot: true
+
+- name: Install only particular updates based on the KB numbers
+ ansible.windows.win_updates:
+ category_names:
+ - SecurityUpdates
+ accept_list:
+ - KB4056892
+ - KB4073117
+
+- name: Exclude updates based on the update title
+ ansible.windows.win_updates:
+ category_names:
+ - SecurityUpdates
+ - CriticalUpdates
+ reject_list:
+ - Windows Malicious Software Removal Tool for Windows
+ - \d{4}-\d{2} Cumulative Update for Windows Server 2016
+
+# Optionally, you can increase the reboot_timeout to survive long updates during reboot
+- name: Ensure we wait long enough for the updates to be applied during reboot
+ ansible.windows.win_updates:
+ reboot: true
+ reboot_timeout: 3600
+
+# Search and download Windows updates
+- name: Search and download Windows updates without installing them
+ ansible.windows.win_updates:
+ state: downloaded
+Return Values
+Common return values are documented here, the following are the fields unique to this module:
+Key |
+Description |
+
|---|---|
| + | The number of updates that failed to install. +Returned: always +Sample: |
+
| + | Updates that were found but were filtered based on blacklist, whitelist or category_names. The return value is in the same form as updates, along with filtered_reason. +Returned: success +Sample: |
+
| + | The reason why this update was filtered. +This value has been deprecated since Returned: always +Sample: |
+
| + | A list of reasons why the update has been filtered. +Can be Returned: success +Sample: |
+
| + | The number of updates found needing to be applied. +Returned: success +Sample: |
+
| + | The number of updates successfully installed or downloaded. +Returned: success +Sample: |
+
| + | True when the target server requires a reboot to complete updates (no further updates can be installed until after a reboot). +Returned: success +Sample: |
+
| + | Set to Returned: success +Sample: |
+
| + | Updates that were found/installed. +The key for each update is the Returned: success + |
+
| + | A list of category strings for this update. +Returned: always +Sample: |
+
| + | Was the update downloaded. +Returned: always +Sample: |
+
| + | The HRESULT code from a failed update. +Returned: on install or download failure +Sample: |
+
| + | The error message with more details on the failure. +Returned: on install or download failure and not running with async +Sample: |
+
| + | Internal Windows Update GUID. +Returned: always +Sample: |
+
| + | Was the update successfully installed. +Returned: always +Sample: |
+
| + | A list of KB article IDs that apply to the update. +Returned: always +Sample: |
+
| + | Display name. +Returned: always +Sample: |
+
Collection links
+ +
+
+
+
+
+ -
+
- Blog +
- Ansible community forum +
- Documentation +
+ Ansible Collections Documentation
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/tag/2.4.0/collections/ansible/windows/win_user_module.html b/tag/2.4.0/collections/ansible/windows/win_user_module.html
new file mode 100644
index 00000000..bc930616
--- /dev/null
+++ b/tag/2.4.0/collections/ansible/windows/win_user_module.html
@@ -0,0 +1,575 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ ansible.windows.win_uri module – Interacts with webservices
+
+
+
+Note
+This module is part of the ansible.windows collection (version 2.4.0).
+It is not included in ansible-core.
+To check whether it is installed, run ansible-galaxy collection list.
To install it, use: ansible-galaxy collection install ansible.windows.
To use it in a playbook, specify: ansible.windows.win_uri.
Synopsis
+-
+
Interacts with FTP, HTTP and HTTPS web services.
+Supports Digest, Basic and WSSE HTTP authentication mechanisms.
+For non-Windows targets, use the ansible.builtin.uri module instead.
+
Parameters
+Parameter |
+Comments |
+
|---|---|
| + | The body of the HTTP request/response to the web service. + |
+
| + | The path to the client certificate (.pfx) that is used for X509 authentication. This path can either be the path to the The WinRM connection must be authenticated with Other authentication types can set client_cert_password when the cert is password protected. + |
+
| + | The password for client_cert if the cert is password protected. + |
+
| + | Sets the “Content-Type” header. + |
+
| + | A filename, when it already exists, this step will be skipped. + |
+
| + | Output the response body to a file. + |
+
| + | Whether or the module should follow redirects. +
When following a redirected URL, the Choices: +
|
+
| + | By default the authentication header is only sent when a webservice responses to an initial request with a 401 status. Since some basic auth services do not properly send a 401, logins will fail. +This option forces the sending of the Basic authentication header upon the original request. +Choices: +
|
+
| + | Extra headers to set on the request. +This should be a dictionary where the key is the header name and the value is the value for that header. + |
+
| + | Header to identify as, generally appears in web server logs. +This is set to the Default: |
+
| + | Specify how many times the module will redirect a connection to an alternative URI before the connection fails. +If set to Default: |
+
| + | The password for proxy_username. + |
+
| + | An explicit proxy to use for the request. +By default, the request will use the IE defined proxy unless use_proxy is set to |
+
| + | Uses the current user’s credentials when authenticating with a proxy host protected with Proxies that use The module will only have access to the user’s credentials if using If not using Choices: +
|
+
| + | The username to use for proxy authentication. + |
+
| + | A filename, when it does not exist, this step will be skipped. + |
+
| + | Whether or not to return the body of the response as a “content” key in the dictionary result. If the reported Content-type is “application/json”, then the JSON is additionally loaded into a key called Choices: +
|
+
| + | A valid, numeric, HTTP status code that signifies success of the request. +Can also be comma separated list of status codes. +Default: |
+
| + | Supports FTP, HTTP or HTTPS URLs in the form of (ftp|http|https)://host.domain:port/path. + |
+
| + | The HTTP Method of the request. +Default: |
+
| + | The password for url_username. + |
+
| + | Specifies how long the request can be pending before it times out (in seconds). +Set to Default: |
+
| + | The username to use for authentication. + |
+
| + | Uses the current user’s credentials when authenticating with a server protected with Sites that use The module will only have access to the user’s credentials if using If not using Choices: +
|
+
| + | If Choices: +
|
+
| + | If This should only be used on personally controlled sites using self-signed certificates. +Choices: +
|
+
See Also
+
+
+See also
+-
+
- ansible.builtin.uri
The official documentation on the ansible.builtin.uri module.
+
+- ansible.windows.win_get_url
Downloads file from HTTP, HTTPS, or FTP to node.
+
+- community.windows.win_inet_proxy
The official documentation on the community.windows.win_inet_proxy module.
+
+
Examples
+- name: Perform a GET and Store Output
+ ansible.windows.win_uri:
+ url: http://example.com/endpoint
+ register: http_output
+
+# Set a HOST header to hit an internal webserver:
+- name: Hit a Specific Host on the Server
+ ansible.windows.win_uri:
+ url: http://example.com/
+ method: GET
+ headers:
+ host: www.somesite.com
+
+- name: Perform a HEAD on an Endpoint
+ ansible.windows.win_uri:
+ url: http://www.example.com/
+ method: HEAD
+
+- name: POST a Body to an Endpoint
+ ansible.windows.win_uri:
+ url: http://www.somesite.com/
+ method: POST
+ body: "{ 'some': 'json' }"
+Return Values
+Common return values are documented here, the following are the fields unique to this module:
+Key |
+Description |
+
|---|---|
| + | The raw content of the HTTP response. +Returned: success and return_content is True +Sample: |
+
| + | The byte size of the response. +Returned: success +Sample: |
+
| + | The number of seconds that elapsed while performing the download. +Returned: always +Sample: |
+
| + | The json structure returned under content as a dictionary. +Returned: success and Content-Type is “application/json” or “application/javascript” and return_content is True +Sample: |
+
| + | The HTTP Status Code of the response. +Returned: success +Sample: |
+
| + | A summary of the status. +Returned: success +Sample: |
+
| + | The Target URL. +Returned: always +Sample: |
+
Collection links
+ +
+
+
+
+
+ -
+
- Blog +
- Ansible community forum +
- Documentation +
+ Ansible Collections Documentation
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/tag/2.4.0/collections/ansible/windows/win_user_right_module.html b/tag/2.4.0/collections/ansible/windows/win_user_right_module.html
new file mode 100644
index 00000000..f5e4c11b
--- /dev/null
+++ b/tag/2.4.0/collections/ansible/windows/win_user_right_module.html
@@ -0,0 +1,345 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ ansible.windows.win_user module – Manages local Windows user accounts
+
+
+
+Note
+This module is part of the ansible.windows collection (version 2.4.0).
+It is not included in ansible-core.
+To check whether it is installed, run ansible-galaxy collection list.
To install it, use: ansible-galaxy collection install ansible.windows.
To use it in a playbook, specify: ansible.windows.win_user.
Synopsis
+-
+
Manages local Windows user accounts.
+For non-Windows targets, use the ansible.builtin.user module instead.
+
Parameters
+Parameter |
+Comments |
+
|---|---|
| + |
Choices: +
|
+
| + | Set the account expiration date for the user. +This value should be in the format Set the value to |
+
| + | Only Choices: +
|
+
| + | Description of the user. + |
+
| + | Full name of the user. + |
+
| + | Adds or removes the user from this comma-separated list of groups, depending on the value of groups_action. +When groups_action is Since |
+
| + | If If If Choices: +
|
+
| + | The designated home directory of the user. + |
+
| + | The login script of the user. + |
+
| + | Name of the user to create, remove or modify. + |
+
| + | Optionally set the user’s password to this (plain text) value. + |
+
| + |
Choices: +
|
+
| + |
Choices: +
|
+
| + | The profile path of the user. + |
+
| + | When When When Choices: +
|
+
| + |
Choices: +
|
+
| + |
Choices: +
|
+
Notes
+
+
+Note
+-
+
The return values are based on the user object after the module options have been set. When running in check mode the values will still reflect the existing user settings and not what they would have been changed to.
+
See Also
+
+
+See also
+-
+
- ansible.builtin.user
The official documentation on the ansible.builtin.user module.
+
+- ansible.windows.win_domain_membership
Manage domain/workgroup membership for a Windows host.
+
+- community.windows.win_domain_user
The official documentation on the community.windows.win_domain_user module.
+
+- ansible.windows.win_group
Add and remove local groups.
+
+- ansible.windows.win_group_membership
Manage Windows local group membership.
+
+- community.windows.win_user_profile
The official documentation on the community.windows.win_user_profile module.
+
+
Examples
+- name: Ensure user bob is present
+ ansible.windows.win_user:
+ name: bob
+ password: B0bP4ssw0rd
+ state: present
+ groups:
+ - Users
+
+- name: Ensure user bob is absent
+ ansible.windows.win_user:
+ name: bob
+ state: absent
+
+- name: Set an account expiration date to the 27th of October 2024 at 2:30PM UTC
+ ansible.windows.win_user:
+ name: bob
+ state: present
+ account_expires: '2024-10-27T14:30:00Z'
+
+- name: Set an account expiration 30 days in the future
+ ansible.windows.win_user:
+ name: bob
+ state: present
+ account_expires: '{{ "%Y-%m-%dT%H:%M:%S%z" | ansible.builtin.strftime(now().timestamp() + (60 * 60 * 24 * 30)) }}'
+
+- name: Remove account expiration date
+ ansible.windows.win_user:
+ name: bob
+ state: present
+ account_expires: never
+Return Values
+Common return values are documented here, the following are the fields unique to this module:
+Key |
+Description |
+
|---|---|
| + | Whether the user is disabled. +Returned: user exists +Sample: |
+
| + | Whether the user is locked. +Returned: user exists +Sample: |
+
| + | The description set for the user. +Returned: user exists +Sample: |
+
| + | The full name set for the user. +Returned: user exists +Sample: |
+
| + | A list of groups and their ADSI path the user is a member of. +Returned: user exists +Sample: |
+
| + | The name of the user +Returned: always +Sample: |
+
| + | Whether the password is expired. +Returned: user exists +Sample: |
+
| + | Whether the password is set to never expire. +Returned: user exists +Sample: |
+
| + | The ADSI path for the user. +Returned: user exists +Sample: |
+
| + | The SID for the user. +Returned: user exists +Sample: |
+
| + | Whether the user can change their own password. +Returned: user exists +Sample: |
+
Collection links
+ +
+
+
+
+
+ -
+
- Blog +
- Ansible community forum +
- Documentation +
+ Ansible Collections Documentation
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/tag/2.4.0/collections/ansible/windows/win_wait_for_module.html b/tag/2.4.0/collections/ansible/windows/win_wait_for_module.html
new file mode 100644
index 00000000..b1ec439a
--- /dev/null
+++ b/tag/2.4.0/collections/ansible/windows/win_wait_for_module.html
@@ -0,0 +1,400 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ ansible.windows.win_user_right module – Manage Windows User Rights
+
+
+
+Note
+This module is part of the ansible.windows collection (version 2.4.0).
+It is not included in ansible-core.
+To check whether it is installed, run ansible-galaxy collection list.
To install it, use: ansible-galaxy collection install ansible.windows.
To use it in a playbook, specify: ansible.windows.win_user_right.
Synopsis
+-
+
Add, remove or set User Rights for a group or users or groups.
+You can set user rights for both local and domain accounts.
+
Parameters
+Parameter |
+Comments |
+
|---|---|
| + |
Choices: +
|
+
| + | The name of the User Right as shown by the The module will return an error if the right is invalid. + |
+
| + | A list of users or groups to add/remove on the User Right. +These can be in the form DOMAIN\user-group, user-group@DOMAIN.COM for domain users/groups. +For local users/groups it can be in the form user-group, .\user-group, SERVERNAME\user-group where SERVERNAME is the name of the remote server. +It is highly recommended to use the You can also add special local accounts like SYSTEM and others. +Can be set to an empty list with action=set to remove all accounts from the right. + |
+
Notes
+
+
+Note
+-
+
If the server is domain joined this module can change a right but if a GPO governs this right then the changes won’t last.
+
See Also
+
+
+See also
+-
+
- ansible.windows.win_group
Add and remove local groups.
+
+- ansible.windows.win_group_membership
Manage Windows local group membership.
+
+- ansible.windows.win_user
Manages local Windows user accounts.
+
+
Examples
+---
+- name: Replace the entries of Deny log on locally
+ ansible.windows.win_user_right:
+ name: SeDenyInteractiveLogonRight
+ users:
+ - Guest
+ - Users
+ action: set
+
+- name: Add account to Log on as a service
+ ansible.windows.win_user_right:
+ name: SeServiceLogonRight
+ users:
+ - .\Administrator
+ - '{{ansible_hostname}}\local-user'
+ action: add
+
+- name: Remove accounts who can create Symbolic links
+ ansible.windows.win_user_right:
+ name: SeCreateSymbolicLinkPrivilege
+ users:
+ - SYSTEM
+ - Administrators
+ - DOMAIN\User
+ - group@DOMAIN.COM
+ action: remove
+
+- name: Remove all accounts who cannot log on remote interactively
+ ansible.windows.win_user_right:
+ name: SeDenyRemoteInteractiveLogonRight
+ users: []
+Return Values
+Common return values are documented here, the following are the fields unique to this module:
+Key |
+Description |
+
|---|---|
| + | A list of accounts that were added to the right, this is empty if no accounts were added. +Returned: success +Sample: |
+
| + | A list of accounts that were removed from the right, this is empty if no accounts were removed. +Returned: success +Sample: |
+
Collection links
+ +
+
+
+
+
+ -
+
- Blog +
- Ansible community forum +
- Documentation +
+ Ansible Collections Documentation
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/tag/2.4.0/collections/ansible/windows/win_whoami_module.html b/tag/2.4.0/collections/ansible/windows/win_whoami_module.html
new file mode 100644
index 00000000..9e8f2c5a
--- /dev/null
+++ b/tag/2.4.0/collections/ansible/windows/win_whoami_module.html
@@ -0,0 +1,464 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ ansible.windows.win_wait_for module – Waits for a condition before continuing
+
+
+
+Note
+This module is part of the ansible.windows collection (version 2.4.0).
+It is not included in ansible-core.
+To check whether it is installed, run ansible-galaxy collection list.
To install it, use: ansible-galaxy collection install ansible.windows.
To use it in a playbook, specify: ansible.windows.win_wait_for.
Synopsis
+-
+
You can wait for a set amount of time
timeout, this is the default if nothing is specified.
+Waiting for a port to become available is useful for when services are not immediately available after their init scripts return which is true of certain Java application servers.
+You can wait for a file to exist or not exist on the filesystem.
+This module can also be used to wait for a regex match string to be present in a file.
+You can wait for active connections to be closed before continuing on a local port.
+
Parameters
+Parameter |
+Comments |
+
|---|---|
| + | The maximum number of seconds to wait for a connection to happen before closing and retrying. +Default: |
+
| + | The number of seconds to wait before starting to poll. + |
+
| + | The list of hosts or IPs to ignore when looking for active TCP connections when |
+
| + | A resolvable hostname or IP address to wait for. +If Default: |
+
| + | The path to a file on the filesystem to check. +If If |
+
| + | The port number to poll on |
+
| + | Can be used to match a string in a file. +If If Defaults to a multiline regex. + |
+
| + | Number of seconds to sleep between checks. +Default: |
+
| + | When checking a port, When checking for a file or a search string Choices: +
|
+
| + | The maximum number of seconds to wait for. +Default: |
+
See Also
+
+
+See also
+-
+
- ansible.builtin.wait_for
The official documentation on the ansible.builtin.wait_for module.
+
+- community.windows.win_wait_for_process
The official documentation on the community.windows.win_wait_for_process module.
+
+
Examples
+- name: Wait 300 seconds for port 8000 to become open on the host, don't start checking for 10 seconds
+ ansible.windows.win_wait_for:
+ port: 8000
+ delay: 10
+
+- name: Wait 150 seconds for port 8000 of any IP to close active connections
+ ansible.windows.win_wait_for:
+ host: 0.0.0.0
+ port: 8000
+ state: drained
+ timeout: 150
+
+- name: Wait for port 8000 of any IP to close active connection, ignoring certain hosts
+ ansible.windows.win_wait_for:
+ host: 0.0.0.0
+ port: 8000
+ state: drained
+ exclude_hosts: ['10.2.1.2', '10.2.1.3']
+
+- name: Wait for file C:\temp\log.txt to exist before continuing
+ ansible.windows.win_wait_for:
+ path: C:\temp\log.txt
+
+- name: Wait until process complete is in the file before continuing
+ ansible.windows.win_wait_for:
+ path: C:\temp\log.txt
+ regex: process complete
+
+- name: Wait until file is removed
+ ansible.windows.win_wait_for:
+ path: C:\temp\log.txt
+ state: absent
+
+- name: Wait until port 1234 is offline but try every 10 seconds
+ ansible.windows.win_wait_for:
+ port: 1234
+ state: absent
+ sleep: 10
+Return Values
+Common return values are documented here, the following are the fields unique to this module:
+Key |
+Description |
+
|---|---|
| + | The elapsed seconds between the start of poll and the end of the module. This includes the delay if the option is set. +Returned: always +Sample: |
+
| + | The number of attempts to poll the file or port before module finishes. +Returned: always +Sample: |
+
Collection links
+ +
+
+
+
+
+ -
+
- Blog +
- Ansible community forum +
- Documentation +
+ Ansible Collections Documentation
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/tag/2.4.0/collections/environment_variables.html b/tag/2.4.0/collections/environment_variables.html
new file mode 100644
index 00000000..82db8390
--- /dev/null
+++ b/tag/2.4.0/collections/environment_variables.html
@@ -0,0 +1,154 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ ansible.windows.win_whoami module – Get information about the current user and process
+
+
+
+Note
+This module is part of the ansible.windows collection (version 2.4.0).
+It is not included in ansible-core.
+To check whether it is installed, run ansible-galaxy collection list.
To install it, use: ansible-galaxy collection install ansible.windows.
To use it in a playbook, specify: ansible.windows.win_whoami.
Synopsis
+-
+
Designed to return the same information as the
whoami /allcommand.
+Also includes information missing from
whoamisuch as logon metadata like logon rights, id, type.
+
Notes
+
+
+Note
+-
+
If running this module with a non admin user, the logon rights will be an empty list as Administrator rights are required to query LSA for the information.
+
See Also
+
+
+See also
+-
+
- community.windows.win_credential
The official documentation on the community.windows.win_credential module.
+
+- ansible.windows.win_group_membership
Manage Windows local group membership.
+
+- ansible.windows.win_user_right
Manage Windows User Rights.
+
+
Examples
+- name: Get whoami information
+ ansible.windows.win_whoami:
+Return Values
+Common return values are documented here, the following are the fields unique to this module:
+Key |
+Description |
+
|---|---|
| + | The running account SID details. +Returned: success + |
+
| + | The account name of the account SID. +Returned: success +Sample: |
+
| + | The domain name of the account SID. +Returned: success +Sample: |
+
| + | The SID in string form. +Returned: success +Sample: |
+
| + | The type of SID. +Returned: success +Sample: |
+
| + | The name of the authentication package used to authenticate the user in the session. +Returned: success +Sample: |
+
| + | The DNS name of the logon session, this is an empty string if this is not set. +Returned: success +Sample: |
+
| + | A list of groups and attributes that the user is a member of. +Returned: success +Sample: |
+
| + | The impersonation level of the token, only valid if Returned: success +Sample: |
+
| + | The mandatory label set to the logon session. +Returned: success + |
+
| + | The account name of the label SID. +Returned: success +Sample: |
+
| + | The domain name of the label SID. +Returned: success +Sample: |
+
| + | The SID in string form. +Returned: success +Sample: |
+
| + | The type of SID. +Returned: success +Sample: |
+
| + | The name of the domain used to authenticate the owner of the session. +Returned: success +Sample: |
+
| + | The logon time in ISO 8601 format +Returned: success +Sample: |
+
| + | The unique identifier of the logon session. +Returned: success +Sample: |
+
| + | The name of the server used to authenticate the owner of the logon session. +Returned: success +Sample: |
+
| + | The logon type that identifies the logon method, see https://msdn.microsoft.com/en-us/library/windows/desktop/aa380129.aspx. +Returned: success +Sample: |
+
| + | A dictionary of privileges and their state on the logon token. +Returned: success +Sample: |
+
| + | A list of logon rights assigned to the logon. +Returned: success and running user is a member of the local Administrators group +Sample: |
+
| + | The token type to indicate whether it is a primary or impersonation token. +Returned: success +Sample: |
+
| + | The user principal name of the current user. +Returned: success +Sample: |
+
| + | The user flags for the logon session, see UserFlags in https://msdn.microsoft.com/en-us/library/windows/desktop/aa380128. +Returned: success +Sample: |
+
Collection links
+ +
+
+
+
+
+ -
+
- Blog +
- Ansible community forum +
- Documentation +
+ Ansible Collections Documentation
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/tag/2.4.0/collections/index.html b/tag/2.4.0/collections/index.html
new file mode 100644
index 00000000..13cc0c9a
--- /dev/null
+++ b/tag/2.4.0/collections/index.html
@@ -0,0 +1,162 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Index of all Collection Environment Variables
+The following index documents all environment variables declared by plugins in collections. +Environment variables used by the ansible-core configuration are documented in Ansible Configuration Settings.
+No environment variables have been defined.
+
+
+
+
+
+ -
+
- Blog +
- Ansible community forum +
- Documentation +
+ Ansible Collections Documentation
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/tag/2.4.0/collections/index_filter.html b/tag/2.4.0/collections/index_filter.html
new file mode 100644
index 00000000..9967b9ce
--- /dev/null
+++ b/tag/2.4.0/collections/index_filter.html
@@ -0,0 +1,162 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Collection Index
+These are the collections documented here.
+ +
+
+
+
+
+
+
+ -
+
- Blog +
- Ansible community forum +
- Documentation +
+ Ansible Collections Documentation
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/tag/2.4.0/collections/index_module.html b/tag/2.4.0/collections/index_module.html
new file mode 100644
index 00000000..c6efbe84
--- /dev/null
+++ b/tag/2.4.0/collections/index_module.html
@@ -0,0 +1,204 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Index of all Filter Plugins
+ansible.windows
+-
+
ansible.windows.quote – Quotes argument(s) for various Windows shells
+
+
+
+
+
+ -
+
- Blog +
- Ansible community forum +
- Documentation +
+ Ansible Collections Documentation
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/tag/2.4.0/index.html b/tag/2.4.0/index.html
new file mode 100644
index 00000000..40e696f3
--- /dev/null
+++ b/tag/2.4.0/index.html
@@ -0,0 +1,170 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Index of all Modules
+ansible.windows
+-
+
ansible.windows.async_status – Obtain status of asynchronous task
+ansible.windows.setup – Gathers facts about remote hosts
+ansible.windows.slurp – Slurps a file from remote nodes
+ansible.windows.win_acl – Set file/directory/registry/certificate permissions for a system user or group
+ansible.windows.win_acl_inheritance – Change ACL inheritance
+ansible.windows.win_certificate_store – Manages the certificate store
+ansible.windows.win_command – Executes a command on a remote Windows node
+ansible.windows.win_copy – Copies files to remote locations on windows hosts
+ansible.windows.win_dns_client – Configures DNS lookup on Windows hosts
+ansible.windows.win_domain – Ensures the existence of a Windows domain
+ansible.windows.win_domain_controller – Manage domain controller/member server state for a Windows host
+ansible.windows.win_domain_membership – Manage domain/workgroup membership for a Windows host
+ansible.windows.win_dsc – Invokes a PowerShell DSC configuration
+ansible.windows.win_environment – Modify environment variables on windows hosts
+ansible.windows.win_feature – Installs and uninstalls Windows Features on Windows Server
+ansible.windows.win_file – Creates, touches or removes files or directories
+ansible.windows.win_find – Return a list of files based on specific criteria
+ansible.windows.win_get_url – Downloads file from HTTP, HTTPS, or FTP to node
+ansible.windows.win_group – Add and remove local groups
+ansible.windows.win_group_membership – Manage Windows local group membership
+ansible.windows.win_hostname – Manages local Windows computer name
+ansible.windows.win_optional_feature – Manage optional Windows features
+ansible.windows.win_owner – Set owner
+ansible.windows.win_package – Installs/uninstalls an installable package
+ansible.windows.win_path – Manage Windows path environment variables
+ansible.windows.win_ping – A windows version of the classic ping module
+ansible.windows.win_powershell – Run PowerShell scripts
+ansible.windows.win_reboot – Reboot a windows machine
+ansible.windows.win_reg_stat – Get information about Windows registry keys
+ansible.windows.win_regedit – Add, change, or remove registry keys and values
+ansible.windows.win_service – Manage and query Windows services
+ansible.windows.win_service_info – Gather information about Windows services
+ansible.windows.win_share – Manage Windows shares
+ansible.windows.win_shell – Execute shell commands on target hosts
+ansible.windows.win_stat – Get information about Windows files
+ansible.windows.win_tempfile – Creates temporary files and directories
+ansible.windows.win_template – Template a file out to a remote server
+ansible.windows.win_updates – Download and install Windows updates
+ansible.windows.win_uri – Interacts with webservices
+ansible.windows.win_user – Manages local Windows user accounts
+ansible.windows.win_user_right – Manage Windows User Rights
+ansible.windows.win_wait_for – Waits for a condition before continuing
+ansible.windows.win_whoami – Get information about the current user and process
+
+
+
+
+
+ -
+
- Blog +
- Ansible community forum +
- Documentation +
+ Ansible Collections Documentation
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/tag/2.4.0/objects.inv b/tag/2.4.0/objects.inv
new file mode 100644
index 00000000..23ad09bb
Binary files /dev/null and b/tag/2.4.0/objects.inv differ
diff --git a/tag/2.4.0/search.html b/tag/2.4.0/search.html
new file mode 100644
index 00000000..7b1f4e4b
--- /dev/null
+++ b/tag/2.4.0/search.html
@@ -0,0 +1,164 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Welcome to my Ansible collection documentation
+This docsite contains documentation of ansible.windows.
+
+
+Collections:
+ +
+
+Plugin indexes:
+ +
+
+Reference indexes:
+ +
+
+
+
+
+ -
+
- Blog +
- Ansible community forum +
- Documentation +
+ Ansible Collections Documentation
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/tag/2.4.0/searchindex.js b/tag/2.4.0/searchindex.js
new file mode 100644
index 00000000..c1103051
--- /dev/null
+++ b/tag/2.4.0/searchindex.js
@@ -0,0 +1 @@
+Search.setIndex({"alltitles": {"Ansible.Windows": [[2, "ansible-windows"]], "Attributes": [[1, "attributes"]], "Authors": [[1, "authors"], [3, "authors"], [4, "authors"], [5, "authors"], [6, "authors"], [7, "authors"], [8, "authors"], [9, "authors"], [10, "authors"], [11, "authors"], [12, "authors"], [13, "authors"], [14, "authors"], [15, "authors"], [16, "authors"], [17, "authors"], [18, "authors"], [19, "authors"], [20, "authors"], [21, "authors"], [22, "authors"], [23, "authors"], [24, "authors"], [25, "authors"], [26, "authors"], [27, "authors"], [28, "authors"], [29, "authors"], [30, "authors"], [31, "authors"], [32, "authors"], [33, "authors"], [34, "authors"], [35, "authors"], [36, "authors"], [37, "authors"], [38, "authors"], [39, "authors"], [40, "authors"], [41, "authors"], [42, "authors"], [43, "authors"], [44, "authors"], [45, "authors"]], "Collection Index": [[47, "collection-index"]], "Collection links": [[1, "collection-links"], [3, "collection-links"], [4, "collection-links"], [5, "collection-links"], [6, "collection-links"], [7, "collection-links"], [8, "collection-links"], [9, "collection-links"], [10, "collection-links"], [11, "collection-links"], [12, "collection-links"], [13, "collection-links"], [14, "collection-links"], [15, "collection-links"], [16, "collection-links"], [17, "collection-links"], [18, "collection-links"], [19, "collection-links"], [20, "collection-links"], [21, "collection-links"], [22, "collection-links"], [23, "collection-links"], [24, "collection-links"], [25, "collection-links"], [26, "collection-links"], [27, "collection-links"], [28, "collection-links"], [29, "collection-links"], [30, "collection-links"], [31, "collection-links"], [32, "collection-links"], [33, "collection-links"], [34, "collection-links"], [35, "collection-links"], [36, "collection-links"], [37, "collection-links"], [38, "collection-links"], [39, "collection-links"], [40, "collection-links"], [41, "collection-links"], [42, "collection-links"], [43, "collection-links"], [44, "collection-links"], [45, "collection-links"]], "Collections in the Ansible Namespace": [[0, "collections-in-the-ansible-namespace"]], "Collections:": [[50, null]], "Communication": [[2, "communication"]], "DEPRECATED": [[12, "deprecated"], [13, "deprecated"], [14, "deprecated"]], "Description": [[2, "description"]], "Examples": [[1, "examples"], [3, "examples"], [4, "examples"], [5, "examples"], [6, "examples"], [7, "examples"], [8, "examples"], [9, "examples"], [10, "examples"], [11, "examples"], [12, "examples"], [13, "examples"], [14, "examples"], [15, "examples"], [16, "examples"], [17, "examples"], [18, "examples"], [19, "examples"], [20, "examples"], [21, "examples"], [22, "examples"], [23, "examples"], [24, "examples"], [25, "examples"], [26, "examples"], [27, "examples"], [28, "examples"], [29, "examples"], [30, "examples"], [31, "examples"], [32, "examples"], [33, "examples"], [34, "examples"], [35, "examples"], [36, "examples"], [37, "examples"], [38, "examples"], [39, "examples"], [40, "examples"], [41, "examples"], [42, "examples"], [43, "examples"], [44, "examples"], [45, "examples"]], "Filter Plugins": [[2, "filter-plugins"]], "Index of all Collection Environment Variables": [[46, "index-of-all-collection-environment-variables"]], "Index of all Filter Plugins": [[48, "index-of-all-filter-plugins"]], "Index of all Modules": [[49, "index-of-all-modules"]], "Input": [[3, "input"]], "Keyword parameters": [[3, "keyword-parameters"]], "Modules": [[2, "modules"]], "Notes": [[4, "notes"], [5, "notes"], [7, "notes"], [8, "notes"], [9, "notes"], [10, "notes"], [15, "notes"], [16, "notes"], [19, "notes"], [20, "notes"], [26, "notes"], [27, "notes"], [29, "notes"], [30, "notes"], [31, "notes"], [32, "notes"], [34, "notes"], [36, "notes"], [39, "notes"], [40, "notes"], [42, "notes"], [43, "notes"], [45, "notes"]], "Parameters": [[1, "parameters"], [4, "parameters"], [5, "parameters"], [6, "parameters"], [7, "parameters"], [8, "parameters"], [9, "parameters"], [10, "parameters"], [11, "parameters"], [12, "parameters"], [13, "parameters"], [14, "parameters"], [15, "parameters"], [16, "parameters"], [17, "parameters"], [18, "parameters"], [19, "parameters"], [20, "parameters"], [21, "parameters"], [22, "parameters"], [23, "parameters"], [24, "parameters"], [25, "parameters"], [26, "parameters"], [27, "parameters"], [28, "parameters"], [29, "parameters"], [30, "parameters"], [31, "parameters"], [32, "parameters"], [33, "parameters"], [34, "parameters"], [35, "parameters"], [36, "parameters"], [37, "parameters"], [38, "parameters"], [39, "parameters"], [40, "parameters"], [41, "parameters"], [42, "parameters"], [43, "parameters"], [44, "parameters"]], "Plugin Index": [[2, "plugin-index"]], "Plugin indexes:": [[50, null]], "Reference indexes:": [[50, null]], "Requirements": [[35, "requirements"]], "Return Value": [[3, "return-value"]], "Return Values": [[1, "return-values"], [5, "return-values"], [8, "return-values"], [9, "return-values"], [10, "return-values"], [12, "return-values"], [13, "return-values"], [14, "return-values"], [15, "return-values"], [16, "return-values"], [17, "return-values"], [19, "return-values"], [20, "return-values"], [21, "return-values"], [23, "return-values"], [24, "return-values"], [26, "return-values"], [28, "return-values"], [29, "return-values"], [30, "return-values"], [31, "return-values"], [32, "return-values"], [33, "return-values"], [34, "return-values"], [35, "return-values"], [36, "return-values"], [37, "return-values"], [38, "return-values"], [39, "return-values"], [40, "return-values"], [41, "return-values"], [42, "return-values"], [43, "return-values"], [44, "return-values"], [45, "return-values"]], "See Also": [[1, "see-also"], [3, "see-also"], [4, "see-also"], [5, "see-also"], [6, "see-also"], [7, "see-also"], [9, "see-also"], [10, "see-also"], [12, "see-also"], [13, "see-also"], [14, "see-also"], [16, "see-also"], [17, "see-also"], [18, "see-also"], [20, "see-also"], [21, "see-also"], [22, "see-also"], [23, "see-also"], [24, "see-also"], [25, "see-also"], [26, "see-also"], [27, "see-also"], [28, "see-also"], [29, "see-also"], [30, "see-also"], [31, "see-also"], [32, "see-also"], [33, "see-also"], [34, "see-also"], [36, "see-also"], [37, "see-also"], [38, "see-also"], [39, "see-also"], [40, "see-also"], [41, "see-also"], [42, "see-also"], [43, "see-also"], [44, "see-also"], [45, "see-also"]], "Status": [[12, "status"], [13, "status"], [14, "status"]], "Synopsis": [[1, "synopsis"], [3, "synopsis"], [4, "synopsis"], [5, "synopsis"], [6, "synopsis"], [7, "synopsis"], [8, "synopsis"], [9, "synopsis"], [10, "synopsis"], [11, "synopsis"], [12, "synopsis"], [13, "synopsis"], [14, "synopsis"], [15, "synopsis"], [16, "synopsis"], [17, "synopsis"], [18, "synopsis"], [19, "synopsis"], [20, "synopsis"], [21, "synopsis"], [22, "synopsis"], [23, "synopsis"], [24, "synopsis"], [25, "synopsis"], [26, "synopsis"], [27, "synopsis"], [28, "synopsis"], [29, "synopsis"], [30, "synopsis"], [31, "synopsis"], [32, "synopsis"], [33, "synopsis"], [34, "synopsis"], [35, "synopsis"], [36, "synopsis"], [37, "synopsis"], [38, "synopsis"], [39, "synopsis"], [40, "synopsis"], [41, "synopsis"], [42, "synopsis"], [43, "synopsis"], [44, "synopsis"], [45, "synopsis"]], "Welcome to my Ansible collection documentation": [[50, "welcome-to-my-ansible-collection-documentation"]], "ansible.windows": [[48, "ansible-windows"], [49, "ansible-windows"]], "ansible.windows.async_status module \u2013 Obtain status of asynchronous task": [[1, "ansible-windows-async-status-module-obtain-status-of-asynchronous-task"]], "ansible.windows.quote filter \u2013 Quotes argument(s) for various Windows shells": [[3, "ansible-windows-quote-filter-quotes-argument-s-for-various-windows-shells"]], "ansible.windows.setup module \u2013 Gathers facts about remote hosts": [[4, "ansible-windows-setup-module-gathers-facts-about-remote-hosts"]], "ansible.windows.slurp module \u2013 Slurps a file from remote nodes": [[5, "ansible-windows-slurp-module-slurps-a-file-from-remote-nodes"]], "ansible.windows.win_acl module \u2013 Set file/directory/registry/certificate permissions for a system user or group": [[7, "ansible-windows-win-acl-module-set-file-directory-registry-certificate-permissions-for-a-system-user-or-group"]], "ansible.windows.win_acl_inheritance module \u2013 Change ACL inheritance": [[6, "ansible-windows-win-acl-inheritance-module-change-acl-inheritance"]], "ansible.windows.win_certificate_store module \u2013 Manages the certificate store": [[8, "ansible-windows-win-certificate-store-module-manages-the-certificate-store"]], "ansible.windows.win_command module \u2013 Executes a command on a remote Windows node": [[9, "ansible-windows-win-command-module-executes-a-command-on-a-remote-windows-node"]], "ansible.windows.win_copy module \u2013 Copies files to remote locations on windows hosts": [[10, "ansible-windows-win-copy-module-copies-files-to-remote-locations-on-windows-hosts"]], "ansible.windows.win_dns_client module \u2013 Configures DNS lookup on Windows hosts": [[11, "ansible-windows-win-dns-client-module-configures-dns-lookup-on-windows-hosts"]], "ansible.windows.win_domain module \u2013 Ensures the existence of a Windows domain": [[14, "ansible-windows-win-domain-module-ensures-the-existence-of-a-windows-domain"]], "ansible.windows.win_domain_controller module \u2013 Manage domain controller/member server state for a Windows host": [[12, "ansible-windows-win-domain-controller-module-manage-domain-controller-member-server-state-for-a-windows-host"]], "ansible.windows.win_domain_membership module \u2013 Manage domain/workgroup membership for a Windows host": [[13, "ansible-windows-win-domain-membership-module-manage-domain-workgroup-membership-for-a-windows-host"]], "ansible.windows.win_dsc module \u2013 Invokes a PowerShell DSC configuration": [[15, "ansible-windows-win-dsc-module-invokes-a-powershell-dsc-configuration"]], "ansible.windows.win_environment module \u2013 Modify environment variables on windows hosts": [[16, "ansible-windows-win-environment-module-modify-environment-variables-on-windows-hosts"]], "ansible.windows.win_feature module \u2013 Installs and uninstalls Windows Features on Windows Server": [[17, "ansible-windows-win-feature-module-installs-and-uninstalls-windows-features-on-windows-server"]], "ansible.windows.win_file module \u2013 Creates, touches or removes files or directories": [[18, "ansible-windows-win-file-module-creates-touches-or-removes-files-or-directories"]], "ansible.windows.win_find module \u2013 Return a list of files based on specific criteria": [[19, "ansible-windows-win-find-module-return-a-list-of-files-based-on-specific-criteria"]], "ansible.windows.win_get_url module \u2013 Downloads file from HTTP, HTTPS, or FTP to node": [[20, "ansible-windows-win-get-url-module-downloads-file-from-http-https-or-ftp-to-node"]], "ansible.windows.win_group module \u2013 Add and remove local groups": [[22, "ansible-windows-win-group-module-add-and-remove-local-groups"]], "ansible.windows.win_group_membership module \u2013 Manage Windows local group membership": [[21, "ansible-windows-win-group-membership-module-manage-windows-local-group-membership"]], "ansible.windows.win_hostname module \u2013 Manages local Windows computer name": [[23, "ansible-windows-win-hostname-module-manages-local-windows-computer-name"]], "ansible.windows.win_optional_feature module \u2013 Manage optional Windows features": [[24, "ansible-windows-win-optional-feature-module-manage-optional-windows-features"]], "ansible.windows.win_owner module \u2013 Set owner": [[25, "ansible-windows-win-owner-module-set-owner"]], "ansible.windows.win_package module \u2013 Installs/uninstalls an installable package": [[26, "ansible-windows-win-package-module-installs-uninstalls-an-installable-package"]], "ansible.windows.win_path module \u2013 Manage Windows path environment variables": [[27, "ansible-windows-win-path-module-manage-windows-path-environment-variables"]], "ansible.windows.win_ping module \u2013 A windows version of the classic ping module": [[28, "ansible-windows-win-ping-module-a-windows-version-of-the-classic-ping-module"]], "ansible.windows.win_powershell module \u2013 Run PowerShell scripts": [[29, "ansible-windows-win-powershell-module-run-powershell-scripts"]], "ansible.windows.win_reboot module \u2013 Reboot a windows machine": [[30, "ansible-windows-win-reboot-module-reboot-a-windows-machine"]], "ansible.windows.win_reg_stat module \u2013 Get information about Windows registry keys": [[31, "ansible-windows-win-reg-stat-module-get-information-about-windows-registry-keys"]], "ansible.windows.win_regedit module \u2013 Add, change, or remove registry keys and values": [[32, "ansible-windows-win-regedit-module-add-change-or-remove-registry-keys-and-values"]], "ansible.windows.win_service module \u2013 Manage and query Windows services": [[34, "ansible-windows-win-service-module-manage-and-query-windows-services"]], "ansible.windows.win_service_info module \u2013 Gather information about Windows services": [[33, "ansible-windows-win-service-info-module-gather-information-about-windows-services"]], "ansible.windows.win_share module \u2013 Manage Windows shares": [[35, "ansible-windows-win-share-module-manage-windows-shares"]], "ansible.windows.win_shell module \u2013 Execute shell commands on target hosts": [[36, "ansible-windows-win-shell-module-execute-shell-commands-on-target-hosts"]], "ansible.windows.win_stat module \u2013 Get information about Windows files": [[37, "ansible-windows-win-stat-module-get-information-about-windows-files"]], "ansible.windows.win_tempfile module \u2013 Creates temporary files and directories": [[38, "ansible-windows-win-tempfile-module-creates-temporary-files-and-directories"]], "ansible.windows.win_template module \u2013 Template a file out to a remote server": [[39, "ansible-windows-win-template-module-template-a-file-out-to-a-remote-server"]], "ansible.windows.win_updates module \u2013 Download and install Windows updates": [[40, "ansible-windows-win-updates-module-download-and-install-windows-updates"]], "ansible.windows.win_uri module \u2013 Interacts with webservices": [[41, "ansible-windows-win-uri-module-interacts-with-webservices"]], "ansible.windows.win_user module \u2013 Manages local Windows user accounts": [[42, "ansible-windows-win-user-module-manages-local-windows-user-accounts"]], "ansible.windows.win_user_right module \u2013 Manage Windows User Rights": [[43, "ansible-windows-win-user-right-module-manage-windows-user-rights"]], "ansible.windows.win_wait_for module \u2013 Waits for a condition before continuing": [[44, "ansible-windows-win-wait-for-module-waits-for-a-condition-before-continuing"]], "ansible.windows.win_whoami module \u2013 Get information about the current user and process": [[45, "ansible-windows-win-whoami-module-get-information-about-the-current-user-and-process"]]}, "docnames": ["collections/ansible/index", "collections/ansible/windows/async_status_module", "collections/ansible/windows/index", "collections/ansible/windows/quote_filter", "collections/ansible/windows/setup_module", "collections/ansible/windows/slurp_module", "collections/ansible/windows/win_acl_inheritance_module", "collections/ansible/windows/win_acl_module", "collections/ansible/windows/win_certificate_store_module", "collections/ansible/windows/win_command_module", "collections/ansible/windows/win_copy_module", "collections/ansible/windows/win_dns_client_module", "collections/ansible/windows/win_domain_controller_module", "collections/ansible/windows/win_domain_membership_module", "collections/ansible/windows/win_domain_module", "collections/ansible/windows/win_dsc_module", "collections/ansible/windows/win_environment_module", "collections/ansible/windows/win_feature_module", "collections/ansible/windows/win_file_module", "collections/ansible/windows/win_find_module", "collections/ansible/windows/win_get_url_module", "collections/ansible/windows/win_group_membership_module", "collections/ansible/windows/win_group_module", "collections/ansible/windows/win_hostname_module", "collections/ansible/windows/win_optional_feature_module", "collections/ansible/windows/win_owner_module", "collections/ansible/windows/win_package_module", "collections/ansible/windows/win_path_module", "collections/ansible/windows/win_ping_module", "collections/ansible/windows/win_powershell_module", "collections/ansible/windows/win_reboot_module", "collections/ansible/windows/win_reg_stat_module", "collections/ansible/windows/win_regedit_module", "collections/ansible/windows/win_service_info_module", "collections/ansible/windows/win_service_module", "collections/ansible/windows/win_share_module", "collections/ansible/windows/win_shell_module", "collections/ansible/windows/win_stat_module", "collections/ansible/windows/win_tempfile_module", "collections/ansible/windows/win_template_module", "collections/ansible/windows/win_updates_module", "collections/ansible/windows/win_uri_module", "collections/ansible/windows/win_user_module", "collections/ansible/windows/win_user_right_module", "collections/ansible/windows/win_wait_for_module", "collections/ansible/windows/win_whoami_module", "collections/environment_variables", "collections/index", "collections/index_filter", "collections/index_module", "index"], "envversion": {"sphinx": 61, "sphinx.domains.c": 3, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 9, "sphinx.domains.index": 1, "sphinx.domains.javascript": 3, "sphinx.domains.math": 2, "sphinx.domains.python": 4, "sphinx.domains.rst": 2, "sphinx.domains.std": 2, "sphinx.ext.intersphinx": 1}, "filenames": ["collections/ansible/index.rst", "collections/ansible/windows/async_status_module.rst", "collections/ansible/windows/index.rst", "collections/ansible/windows/quote_filter.rst", "collections/ansible/windows/setup_module.rst", "collections/ansible/windows/slurp_module.rst", "collections/ansible/windows/win_acl_inheritance_module.rst", "collections/ansible/windows/win_acl_module.rst", "collections/ansible/windows/win_certificate_store_module.rst", "collections/ansible/windows/win_command_module.rst", "collections/ansible/windows/win_copy_module.rst", "collections/ansible/windows/win_dns_client_module.rst", "collections/ansible/windows/win_domain_controller_module.rst", "collections/ansible/windows/win_domain_membership_module.rst", "collections/ansible/windows/win_domain_module.rst", "collections/ansible/windows/win_dsc_module.rst", "collections/ansible/windows/win_environment_module.rst", "collections/ansible/windows/win_feature_module.rst", "collections/ansible/windows/win_file_module.rst", "collections/ansible/windows/win_find_module.rst", "collections/ansible/windows/win_get_url_module.rst", "collections/ansible/windows/win_group_membership_module.rst", "collections/ansible/windows/win_group_module.rst", "collections/ansible/windows/win_hostname_module.rst", "collections/ansible/windows/win_optional_feature_module.rst", "collections/ansible/windows/win_owner_module.rst", "collections/ansible/windows/win_package_module.rst", "collections/ansible/windows/win_path_module.rst", "collections/ansible/windows/win_ping_module.rst", "collections/ansible/windows/win_powershell_module.rst", "collections/ansible/windows/win_reboot_module.rst", "collections/ansible/windows/win_reg_stat_module.rst", "collections/ansible/windows/win_regedit_module.rst", "collections/ansible/windows/win_service_info_module.rst", "collections/ansible/windows/win_service_module.rst", "collections/ansible/windows/win_share_module.rst", "collections/ansible/windows/win_shell_module.rst", "collections/ansible/windows/win_stat_module.rst", "collections/ansible/windows/win_tempfile_module.rst", "collections/ansible/windows/win_template_module.rst", "collections/ansible/windows/win_updates_module.rst", "collections/ansible/windows/win_uri_module.rst", "collections/ansible/windows/win_user_module.rst", "collections/ansible/windows/win_user_right_module.rst", "collections/ansible/windows/win_wait_for_module.rst", "collections/ansible/windows/win_whoami_module.rst", "collections/environment_variables.rst", "collections/index.rst", "collections/index_filter.rst", "collections/index_module.rst", "index.rst"], "indexentries": {}, "objects": {}, "objnames": {}, "objtypes": {}, "terms": {"": [2, 4, 6, 7, 9, 15, 16, 20, 24, 26, 27, 29, 31, 33, 34, 36, 39, 41, 42, 45, 48], "0": [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44, 45], "00": [9, 15, 29, 36, 45], "00z": 42, "01": 12, "02": [9, 15, 29, 36], "0240359e": 26, "04": 26, "07": 12, "09": [9, 36], "09cb79e8fc7453c84a07f644e441fd81623b7f98": [19, 37], "0c13154e5d00": 26, "0x": [26, 31], "0x01": 31, "0x16": 31, "0x80240020": 40, "0xbe": 32, "0xef": 32, "0xff2500ae": 32, "0xffffffff": 34, "1": [1, 6, 7, 8, 9, 15, 16, 19, 20, 26, 29, 30, 31, 34, 37, 40, 42, 44, 45], "10": [1, 4, 19, 20, 32, 42, 44, 45], "100": 1, "1000": [1, 34], "10000": 33, "1001": 42, "1024": [19, 37], "1048576": 19, "1066": 33, "10d": 19, "11": [6, 9, 37, 40, 45], "11540": [10, 39], "11t04": 29, "12": [7, 29], "120": 30, "1200": 40, "120000": 33, "1220": [10, 20], "12288": 45, "1234": [15, 44], "127": 44, "1337": 32, "14": [2, 40, 45], "1406487": [20, 44], "1423796390": 10, "147729857856000": 10, "1477984205": [19, 37], "15": [14, 19, 37], "150": 44, "16": [26, 39, 45], "1654078763": 45, "167f0d79": 26, "168": 11, "168ba8c488463f88c6648466a22484b6189e165f": 7, "16b06f60": 26, "17120579f8e2": 26, "18": [9, 36], "192": 11, "194": 40, "1ce20aba": 33, "1d": 19, "1ddeb766e809": 33, "1g": 19, "1gb": 19, "1h": 19, "1mb": 19, "1st": 29, "1w": 19, "2": [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44, 45], "200": [20, 41], "2001": 11, "2007": 40, "2008": 17, "2012": [11, 12, 17, 26, 35, 40], "2012r2": 14, "20150212": [10, 39], "2016": [9, 36, 40], "2017": 45, "2019": [15, 26], "2021": 29, "2022": 12, "2024": 42, "20470143": 45, "21": [42, 45], "2147483647": 26, "2147942402": 40, "22": 31, "220915": [10, 39], "22t13": 15, "23": [30, 41], "2311892": 15, "24": [42, 45], "25": [9, 36], "26": [9, 36], "26ea": 26, "27t06": 45, "27t14": 42, "27th": 42, "2828151810": 42, "2968445802": 45, "2f": 20, "2nd": 29, "3": [11, 12, 13, 14, 16, 24, 26, 29, 32, 40, 44], "30": [20, 26, 40, 41, 42], "300": 44, "3004365": 40, "3010": 26, "30pm": 42, "31": 15, "32": 45, "3221225477": 26, "325771": [9, 36], "32f8": 26, "331f7e34ba97": 26, "3321665": 45, "3322259488": 42, "34": 11, "3600": [19, 30, 40], "360874038559": 1, "3766": 26, "3939402796": 42, "3b20": 26, "3rd": [26, 29], "4": [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44, 45], "401": [12, 20, 26, 41], "4089": 40, "4169": 1, "4294967295": 26, "429568": [9, 36], "4321": 15, "44": 17, "4421": 33, "46": 29, "4694240z": 29, "4884": 26, "48ae": 26, "4a35": 26, "4acd": 26, "4f57": 26, "4ff2": 26, "5": [8, 11, 15, 24, 29, 30, 42, 44, 45], "50": [20, 26, 41], "500": 45, "5000": 34, "509": 8, "513": 45, "5135": 33, "544": 45, "54447": 41, "57": 15, "5cbbc385da37": 26, "5e9b7962f9a": 26, "6": [11, 19, 26, 30], "60": 42, "600": 30, "666": 26, "6a4c": 26, "6b40": 26, "6e642bb8dd5c2e027bf21dd923337cbb4214f827": [10, 20], "7": [26, 29, 39, 40], "755339": [9, 36], "769949647": 45, "786a": 26, "7debe4eb": 26, "7z": 26, "7zip": 26, "8": [16, 19, 26, 35, 39, 40], "8000": 44, "8080": 20, "85f2": 26, "8601": [29, 45], "86400": [19, 33], "8901": 15, "9": 29, "9317": 26, "9430": 33, "9665567e": 26, "97": 10, "9851": 33, "9e94": 26, "9th": 29, "A": [2, 3, 8, 9, 16, 17, 21, 23, 26, 27, 29, 31, 32, 33, 34, 35, 36, 40, 41, 42, 43, 44, 45, 49], "AND": 19, "As": [26, 35, 40], "Be": 20, "By": [3, 15, 20, 26, 29, 30, 40, 41], "For": [3, 4, 6, 7, 9, 10, 12, 13, 14, 16, 18, 19, 20, 22, 26, 27, 28, 29, 30, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43], "ISE": 39, "If": [1, 4, 7, 8, 9, 10, 12, 13, 14, 15, 17, 18, 19, 20, 26, 28, 29, 30, 31, 32, 33, 34, 36, 37, 38, 40, 41, 42, 43, 44, 45], "In": [16, 32, 36, 37], "It": [1, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44, 45], "NOT": [18, 28, 29], "No": [9, 10, 29, 36, 46], "Not": [9, 16, 17], "One": [19, 26, 30], "Or": 30, "The": [1, 3, 4, 5, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44, 45, 46], "There": [9, 15, 36], "These": [0, 2, 3, 4, 26, 29, 34, 43, 47], "To": [1, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44, 45], "Will": [1, 19, 26, 33, 37], "_": 15, "_measure_subset": 4, "_oper": 40, "_operation_opt": 40, "_password": 15, "_raw_param": 9, "_usernam": 15, "a440": 26, "a97e6837f60cec6da4491bab387296bbcd72bdba": 20, "a99c": 26, "aa379572": 45, "aa380128": 45, "aa380129": 45, "aa90": 26, "aa9b": 26, "abc123": 10, "abl": [8, 34, 35], "abort": 30, "about": [2, 6, 7, 18, 25, 29, 32, 34, 40, 49], "abov": [20, 26, 32, 41], "absent": [6, 7, 8, 16, 17, 18, 21, 22, 24, 26, 27, 32, 34, 35, 42, 44], "absolut": [10, 19, 37, 38, 39], "ac": 6, "ac76ba86": 26, "accept": [21, 30, 33, 36, 37, 40], "accept_list": 40, "acces": 26, "access": [6, 7, 8, 9, 10, 15, 18, 19, 20, 26, 29, 33, 34, 35, 36, 37, 41], "accesscontrol": 7, "accessrul": 7, "accord": 40, "account": [2, 4, 5, 8, 13, 15, 34, 43, 45, 49], "account_dis": 42, "account_expir": 42, "account_lock": 42, "account_nam": 45, "acl": [2, 7, 18, 49], "act": 7, "action": [1, 8, 10, 12, 13, 14, 26, 29, 30, 33, 34, 35, 39, 40, 43], "activ": [14, 15, 29, 32, 44], "actual": [5, 9, 15, 26, 30, 36, 41], "ad": [1, 4, 6, 7, 8, 9, 12, 13, 14, 16, 19, 21, 26, 29, 35, 36, 37, 39, 40, 42, 43], "adam": 32, "adapt": [11, 40], "adapter_nam": 11, "add": [2, 7, 13, 17, 21, 26, 27, 29, 30, 31, 33, 34, 35, 39, 42, 43, 49], "addit": [4, 21, 27, 29, 39], "addition": [30, 41], "address": [11, 44], "addressbook": 8, "addsdeploy": 12, "addsdomaincontrol": 12, "admin": [10, 12, 13, 45], "administr": [7, 10, 12, 19, 21, 34, 35, 37, 38, 40, 42, 43, 45], "adsi": 42, "ae29": 40, "aedb": 26, "af0071f3": 26, "affect": 9, "after": [4, 9, 10, 12, 13, 16, 17, 20, 26, 29, 30, 33, 34, 39, 40, 42, 44], "ag": 19, "again": [16, 27, 30], "against": [1, 19, 32], "age_stamp": 19, "agent": [20, 26, 41], "algorithm": [19, 20, 37], "alia": [29, 45], "alias": [5, 11, 18, 19, 20, 30, 31, 32, 34, 37, 38, 41, 44], "aliv": 40, "all": [4, 9, 10, 11, 16, 17, 18, 20, 21, 24, 26, 29, 30, 31, 32, 33, 34, 36, 37, 40, 41, 42, 43, 44, 45, 50], "allo": 26, "allow": [7, 8, 21, 26, 27, 29, 32, 34, 35, 42], "allowalltrustedapp": 26, "along": [14, 40], "alphabet": 19, "alreadi": [13, 26, 30, 34, 39, 40, 41, 42], "also": [8, 15, 35], "altern": [12, 13, 14, 20, 26, 28, 41], "alwai": [1, 9, 12, 13, 14, 15, 16, 17, 19, 20, 21, 23, 26, 27, 29, 30, 31, 33, 34, 36, 37, 39, 40, 41, 42, 44], "ambigu": 43, "amount": [29, 40, 44], "an": [1, 2, 3, 4, 5, 8, 9, 10, 11, 12, 15, 16, 17, 18, 19, 20, 24, 27, 28, 29, 31, 32, 33, 34, 36, 37, 39, 40, 41, 42, 43, 45, 49], "anderson": 24, "andrew": 21, "andrewsaraceni": 21, "angstwad": [17, 20, 42], "ani": [1, 3, 7, 8, 9, 12, 15, 17, 20, 26, 27, 29, 32, 33, 34, 36, 39, 40, 41, 42, 43, 44], "anonym": 15, "anoth": [9, 10, 16, 29, 37], "another_var": 16, "anotherstrongpass": 8, "ansibl": [46, 47], "ansible_async": 1, "ansible_become_method": 26, "ansible_become_pass": 26, "ansible_become_password": [10, 26], "ansible_become_us": [10, 26], "ansible_hostnam": 43, "ansible_job_id": 1, "ansible_manag": 39, "ansible_my_fact": 4, "ansible_password": 15, "ansible_remote_tmp": 10, "ansible_ssh_arg": 40, "ansible_us": [10, 15], "ansible_winrm_transport": 8, "ansible_wu": 40, "antimalware_light": 33, "anyth": [10, 29, 31, 37], "apach": [6, 25], "api": [9, 36], "app": 26, "appdata": [10, 32, 38], "appear": [20, 26, 27, 29, 30, 40, 41], "append": [27, 40], "apphost": 31, "appli": [7, 15, 16, 17, 26, 30, 32, 40], "applic": [9, 16, 26, 27, 29, 40, 41, 44], "applicationdb": 26, "appmodelunlock": 26, "apppool": [7, 8], "appropri": 20, "appx": 26, "appxbundl": 26, "appxpackag": 26, "ar": [0, 1, 2, 3, 4, 5, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 19, 20, 21, 23, 24, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44, 45, 46, 47], "archiv": [15, 19, 37], "arg": [9, 29, 36], "argument": [2, 9, 26, 29, 33, 34, 36, 48], "argument1": 3, "argv": [3, 9], "arrai": [15, 32], "articl": [17, 40], "asn": 8, "aspx": [7, 8, 40, 45], "assembl": 10, "assembli": 29, "assemblyqualifiednam": 29, "assign": [11, 12, 29, 34, 43, 45], "associ": 29, "async": [1, 40], "async_statu": [2, 49], "async_wrapp": 1, "asynchron": [2, 49], "atim": 19, "attempt": [9, 30, 44], "attribut": [15, 19, 37, 45], "auth": [20, 26, 29, 41], "authent": [15, 20, 26, 41, 45], "authentication_packag": 45, "authenticationinfo": 15, "author": 2, "authroot": 8, "auto": [26, 33, 34], "autodecrypt": 10, "autom": 40, "automat": [4, 14, 40], "avail": [1, 4, 13, 15, 16, 17, 20, 24, 26, 27, 34, 40, 41, 44], "avoid": [4, 15, 34, 43], "b": [26, 31], "b0bp4ssw0rd": 42, "b198": 26, "b397a02d893c": 26, "b64decod": 5, "b699": 26, "back": [10, 29, 30, 34, 37, 39, 40], "background": [36, 40], "backslash": [10, 27], "backup": [9, 10, 21, 35, 39], "backup_fil": [10, 39], "backuptarget": 9, "bad": 29, "bak": [10, 39], "banik": 23, "bar": [37, 41], "base": [2, 3, 8, 9, 14, 15, 16, 26, 27, 29, 30, 33, 35, 36, 37, 40, 42, 49], "base64": [5, 8, 33], "basenam": 10, "basetyp": 29, "basic": [15, 20, 26, 29, 41], "baumann": 35, "bb35": 26, "bc05633694e675449136679a658281f17a191087": 8, "bc94a1db745f": 26, "bd7af104cf1872bdb518d95c9534ea941665fd27": 8, "becaus": [10, 12, 34, 39, 40], "becom": [8, 10, 12, 16, 20, 26, 27, 40, 41, 44], "become_flag": 26, "become_method": [8, 26, 40], "become_us": [8, 10, 40], "been": [6, 12, 13, 14, 16, 20, 26, 30, 31, 34, 40, 42, 46], "befor": [2, 3, 9, 16, 20, 23, 26, 27, 29, 30, 32, 33, 34, 36, 41, 49], "before_valu": 16, "begin": [11, 34, 39], "behavior": [18, 30, 33, 40], "behaviour": [20, 26, 29, 30, 33, 34], "behind": 29, "being": [1, 10, 15, 18, 20, 26, 29, 30, 39, 41], "belong": 33, "below": [35, 39], "best": [16, 34, 36, 39], "better": 36, "between": [20, 34, 44], "bewar": [30, 32, 39, 40], "bin": 4, "binari": [8, 32, 33], "binary_properti": 31, "bind": [8, 15], "bindinginfo": 15, "blacklist": 40, "blakfeld": 41, "blob": 5, "block": 39, "block_end_str": 39, "block_start_str": 39, "bmlvdk": 38, "bob": 42, "bodi": 41, "boolean": [4, 6, 7, 8, 9, 10, 12, 13, 14, 15, 17, 19, 20, 23, 24, 25, 26, 30, 31, 32, 33, 34, 35, 36, 37, 39, 40, 41, 42], "boot": 30, "boot_time_command": 30, "borean": [2, 3, 8, 10, 19, 26, 29, 31, 32, 33, 43, 44, 45], "both": [8, 9, 10, 26, 29, 30, 37, 43], "bounc": 34, "bovin": 7, "box": 10, "branchcach": 35, "brian": [11, 16], "briantist": [11, 16], "broadcast": [16, 27, 33, 34], "brown": 41, "browseonli": 40, "bubbl": 4, "build": 38, "built": 29, "builtin": [1, 4, 5, 7, 9, 10, 15, 18, 19, 20, 22, 28, 29, 30, 34, 36, 37, 38, 39, 40, 41, 42, 43, 44, 45], "bypass": [1, 8, 29], "bypass_host_loop": 1, "byte": [19, 32, 37, 39, 41], "c": [3, 5, 6, 7, 8, 9, 10, 11, 14, 15, 16, 17, 18, 19, 20, 25, 26, 27, 29, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 44], "c676a89018c4d5902353545343634f35e6b3a659": 15, "c68d103bdccf": 26, "ca": 8, "cach": [1, 40], "caching_mod": 35, "cachingmod": 35, "calcul": [20, 26], "call": [4, 15, 26, 41], "caller": 4, "can": [1, 3, 4, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 24, 26, 27, 29, 30, 32, 33, 34, 35, 36, 39, 40, 41, 42, 43, 44], "can_pause_and_continu": 34, "cancel": 40, "cannot": [8, 9, 14, 16, 20, 30, 36, 43], "caption": 11, "captur": 36, "carson": 24, "case": [12, 16, 27, 35, 36, 37, 40], "cast": 31, "catalog": 40, "categori": [29, 40], "category_id": 29, "category_info": 29, "category_nam": 40, "categoryinfo": 29, "caus": [28, 29, 30, 39], "cchurch": [28, 37, 42], "center": 40, "ceo": 35, "cer": 8, "cert": [7, 8, 20, 26, 41], "certain": [9, 33, 39, 44], "certif": [2, 6, 18, 20, 25, 26, 37, 41, 49], "certificateauthor": 8, "certificatestorenam": 15, "certificatethumbprint": 15, "cf2bea3c": 26, "cfg": 39, "chang": [1, 2, 7, 8, 9, 10, 12, 13, 14, 15, 16, 17, 18, 19, 20, 23, 25, 26, 27, 29, 31, 34, 35, 36, 37, 39, 42, 43, 49], "channel": 2, "char": 3, "charact": [14, 20, 39], "chdir": [9, 26, 29, 36], "check": [1, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44, 45], "check_mod": [1, 29], "checkmod": 29, "checkpoint": 33, "checksum": [10, 19, 20, 37], "checksum_algorithm": [19, 20, 37], "checksum_dest": 20, "checksum_src": 20, "checksum_url": 20, "child": [26, 36], "childitem": [15, 29], "chocolatei": [17, 24, 26, 40], "choic": [1, 3, 4, 6, 7, 8, 10, 12, 13, 14, 16, 17, 18, 19, 20, 21, 22, 24, 25, 26, 27, 29, 32, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44], "choos": 19, "chri": [22, 28, 34, 37, 42], "chrishoffman": [22, 34], "church": [28, 37, 42], "ciminst": [15, 30], "cimmethod": 15, "circumst": [9, 36], "class": [20, 29], "classic": [2, 49], "classnam": 30, "classpath": 27, "clean": [1, 13, 29], "cleanup": 1, "clear": [32, 42], "clever": 12, "client": [11, 15, 17, 20, 26, 40, 41], "client_cert": [20, 26, 41], "client_cert_password": [20, 26, 41], "clobber": [10, 39], "clock": 30, "close": 44, "closer": 27, "cluster": [9, 35, 36], "cmd": [3, 9, 34, 36], "cmdlet": [12, 17, 24, 26, 35], "cmdletbind": 29, "code": [9, 17, 20, 26, 29, 33, 36, 40, 41], "codepag": [9, 36], "collect": 2, "com": [4, 7, 8, 9, 12, 15, 20, 26, 29, 30, 35, 36, 40, 41, 43, 45], "combin": 6, "come": [15, 30], "comma": [7, 15, 17, 32, 35, 41, 42], "command": [2, 3, 12, 17, 18, 24, 29, 30, 33, 34, 45, 49], "comment": [1, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44], "common": [1, 5, 8, 9, 10, 12, 13, 14, 15, 16, 17, 19, 20, 21, 23, 24, 26, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44, 45], "common_files_dir": 31, "commonfilesdir": 31, "commun": [1, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44, 45], "compani": 35, "compar": [6, 19, 27], "comparison": 27, "complet": [15, 20, 21, 23, 24, 26, 40, 44], "complex": [6, 10, 15, 17, 19, 29, 33, 37, 45], "compon": [26, 34], "comput": [2, 12, 13, 14, 49], "condit": [1, 2, 29, 49], "conf": [10, 18, 39], "config": [10, 39], "configur": [2, 3, 12, 23, 26, 32, 33, 34, 39, 40, 46, 49], "configurationfil": 26, "conflict": 15, "conjunct": [19, 26, 34], "connect": [10, 11, 13, 16, 20, 26, 28, 30, 40, 41, 44], "connect_timeout": [30, 44], "connect_timeout_sec": 30, "connector": 40, "consid": [10, 26, 29, 36], "consider": 1, "consol": [9, 29, 36], "constant": [34, 43], "contain": [5, 8, 9, 12, 15, 19, 20, 21, 26, 29, 31, 32, 33, 37, 39, 40, 50], "containerinherit": 7, "content": [5, 10, 19, 20, 26, 39, 41], "content_length": 41, "content_typ": 41, "context": 26, "continu": [2, 29, 33, 34, 40, 49], "continue_pend": 33, "control": [1, 2, 6, 10, 11, 13, 14, 19, 20, 26, 29, 32, 33, 34, 35, 39, 40, 41, 43, 49], "controlmast": 40, "controls_accept": 33, "convent": 15, "convert": [15, 20, 26], "convertto": 29, "copi": [2, 6, 39, 49], "core": [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44, 45, 46], "coremessag": 34, "coremessagingregistrar": 34, "corpor": 40, "correct": [8, 15], "correctli": 15, "correspond": [1, 10, 17, 29, 30, 32, 39, 40], "corwin": 41, "could": [26, 30, 40], "count": [33, 39], "crash": [28, 34], "creat": [2, 6, 7, 8, 9, 10, 12, 14, 15, 19, 22, 25, 29, 32, 34, 36, 37, 39, 41, 42, 43, 49], "create_dns_deleg": 14, "creates_": 26, "creates_path": 26, "creates_servic": 26, "creates_vers": 26, "creation": 14, "creationtim": [19, 37], "credenti": [8, 12, 13, 20, 26, 29, 30, 41], "credssp": [8, 20, 26, 41], "credusernam": 29, "criteria": [2, 33, 49], "critic": [33, 34, 40], "criticalupd": 40, "cryptographi": 8, "ctime": 19, "cumul": 40, "current": [2, 8, 9, 10, 16, 19, 20, 26, 27, 29, 32, 33, 34, 36, 37, 40, 41, 49], "current_vers": 31, "current_version_default": 31, "currentus": [8, 20, 26, 41], "currentvers": [26, 31], "custom": [9, 12, 15, 29, 30, 33, 34], "custom_app_var": 16, "d": [12, 19, 26, 32, 40, 42], "d1437f51": 26, "dabondi": 35, "dag": [38, 41], "dagwieer": [38, 41], "dai": [19, 42], "dat": 32, "data": [5, 9, 12, 19, 26, 28, 29, 32, 33, 37], "data_chang": 32, "data_item": 33, "data_type_chang": 32, "databas": [12, 14], "database_path": [12, 14], "datatyp": 32, "date": [15, 26, 39, 42], "datetim": [15, 29, 31], "datetimeoffset": 29, "datetimeopt": 15, "datetimeresourc": 15, "davi": [2, 9, 11, 12, 13, 14, 27, 30, 36, 40], "david": 35, "db8": 11, "dbname": 26, "dbserver": 26, "dc": [12, 13], "dc01": 45, "dc_promot": 12, "de23": 40, "deal": [10, 26], "debug": [5, 11, 12, 29, 37], "debugprefer": 29, "decim": 32, "declar": 46, "decrypt": 10, "dedic": 6, "dedupl": 6, "deep": 29, "default": [1, 3, 4, 6, 7, 8, 10, 12, 14, 15, 17, 19, 20, 21, 22, 24, 25, 26, 27, 28, 29, 30, 31, 32, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44, 45], "defaultport": 15, "defin": [9, 16, 20, 26, 29, 33, 34, 35, 39, 40, 41, 46], "definit": [15, 40], "delai": [1, 30, 33, 34, 44], "delay_m": [33, 34], "deleg": [4, 8, 14, 20, 26, 41], "delet": [7, 18, 29, 32, 34], "delete_kei": 32, "delimit": [3, 9, 36], "delta": [9, 36], "demot": 12, "deni": [6, 7, 35, 43], "depend": [15, 24, 29, 33, 34, 40, 41, 42], "depended_bi": 34, "dependency_act": 34, "dependency_of": 33, "deploi": 22, "deprec": [17, 40], "depth": [19, 29], "der": 8, "deriv": [8, 17, 29], "descend": [19, 26], "describ": [3, 20, 39], "descript": [1, 3, 5, 8, 9, 10, 12, 13, 14, 15, 16, 17, 19, 20, 21, 22, 23, 24, 26, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44, 45], "design": [39, 42, 45], "desir": [13, 21, 34], "desktop": [21, 26, 33, 34, 45], "desktop_interact": [33, 34], "despit": 30, "dest": [10, 18, 20, 37, 38, 39, 41], "destin": [10, 15, 20, 39], "destinationpath": 15, "detail": [1, 8, 26, 29, 32, 34, 35, 40, 42, 45], "detect": [29, 30], "determin": [10, 19, 26, 30, 37, 39], "devblog": 15, "develop": [26, 40], "dhcp": 11, "dict": [3, 15, 16, 29], "dictionari": [15, 16, 19, 20, 26, 29, 31, 33, 34, 37, 40, 41, 45], "did": [20, 40], "didn": 16, "diff": [1, 29, 32], "diff_mod": 1, "differ": [10, 15, 20, 26, 29, 30, 39, 41, 42], "digest": [15, 20, 41], "dir": [4, 10], "direct": [20, 29], "directli": [4, 8, 9, 10, 15, 36], "directori": [2, 5, 6, 8, 9, 10, 12, 14, 15, 19, 25, 26, 27, 29, 35, 36, 37, 40, 42, 49], "directresourceaccess": 15, "disabl": [6, 11, 15, 24, 32, 33, 34, 40, 42, 45], "disallow": 8, "disk": [12, 14, 35], "displai": [17, 30, 33, 34, 40], "display_nam": [17, 33, 34], "dn": [2, 12, 13, 14, 23, 45, 49], "dns_domain_nam": [12, 13, 14, 45], "dns_log": 11, "dns_server": 11, "dnsclientserveraddress": 11, "do": [8, 9, 16, 18, 19, 20, 26, 32, 36, 41], "doc": [2, 4, 9, 12, 15, 29, 30, 36], "docsit": 50, "document": [0, 1, 4, 5, 7, 8, 9, 10, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 26, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44, 45, 46, 47], "doe": [1, 9, 10, 12, 16, 18, 20, 26, 27, 29, 33, 36, 39, 40, 41, 44], "doesn": [10, 26, 40], "domain": [2, 21, 26, 34, 41, 42, 43, 45, 49], "domain_admin_password": [12, 13], "domain_admin_us": [12, 13], "domain_control": 12, "domain_instal": 14, "domain_join": 33, "domain_leav": 33, "domain_log_path": 12, "domain_mod": 14, "domain_nam": [14, 45], "domain_netbios_nam": 14, "domain_ou_path": 13, "domain_st": 13, "don": [8, 44], "done": 34, "dotnet": [9, 36], "doubl": 10, "down": 30, "download": [2, 10, 26, 41, 49], "dpapi": 26, "drain": 44, "dramat": 29, "drivelett": [17, 24], "driver": [33, 34], "drop": [20, 26, 41], "dsc": [2, 49], "dsctest": 15, "dt": [26, 42], "due": [26, 35], "dure": [17, 26, 40], "durivag": [17, 20, 42], "dword": [26, 32], "dynam": 15, "e": [4, 7, 10, 15, 19, 26, 29, 35, 39], "each": [3, 9, 15, 16, 19, 26, 29, 30, 33, 34, 39, 40, 42], "earthris": 20, "easi": [4, 32], "echo": [29, 36], "edit": [15, 34], "ef": 32, "effect": [15, 19, 23, 40], "effici": 10, "eg": [27, 36], "either": [8, 17, 20, 24, 26, 27, 32, 34, 40, 41], "elaps": [20, 30, 41, 44], "element": [4, 8, 9, 11, 15, 16, 17, 19, 21, 24, 26, 27, 29, 31, 33, 34, 35, 36, 37, 40, 41, 42, 43, 44, 45], "els": 29, "empti": [11, 16, 18, 21, 29, 31, 32, 33, 34, 42, 43, 45], "en": [7, 8, 12, 15, 30, 32, 35, 40, 43, 45], "enabl": [6, 7, 11, 24, 26, 29, 30, 32, 45], "encod": [5, 8, 9, 36, 39], "encount": 29, "encrypt": [13, 35], "end": [1, 9, 10, 20, 27, 34, 36, 39, 44], "endpoint": [8, 30, 41], "endraw": 39, "enforc": 30, "engin": 15, "enough": 40, "ensur": [2, 3, 8, 10, 12, 13, 15, 16, 20, 21, 24, 26, 27, 29, 30, 33, 34, 40, 42, 44, 49], "entir": [16, 32], "entri": [3, 6, 9, 19, 29, 31, 32, 35, 40, 43], "enu": 26, "enum": 29, "enumer": [7, 35], "enumeratesubkei": 7, "env": 9, "environ": [2, 9, 14, 40, 49, 50], "epoch": [19, 37], "eq": [15, 29], "equal": 19, "equival": [26, 30], "eras": 1, "error": [1, 8, 9, 19, 20, 29, 33, 34, 36, 37, 40, 43], "error_act": 29, "error_control": [33, 34], "error_detail": 29, "erroract": 29, "erroractionprefer": 29, "errorrecord": 29, "escap": [3, 9, 15, 20, 26], "estim": 33, "etc": [9, 40], "ethernet": 11, "evalu": [19, 30, 39], "even": [4, 17, 29], "event": [16, 27, 33, 34], "everi": [19, 20, 32, 44], "ex": [1, 3, 7, 9, 26, 29, 32, 33, 34], "exact": 15, "exactli": 30, "examin": 19, "examplekei": 15, "exceed": 34, "except": [8, 28, 29], "exclud": [19, 37, 40], "exclude_host": 44, "exclus": [9, 29], "execut": [1, 2, 3, 4, 7, 10, 15, 26, 29, 34, 35, 49], "executefil": 7, "executionpolici": 29, "exist": [2, 8, 9, 10, 12, 13, 16, 18, 19, 20, 21, 26, 27, 29, 31, 32, 33, 34, 36, 37, 39, 40, 41, 42, 43, 44, 49], "exit": [17, 30, 36], "exitcod": 17, "expand": 32, "expandproperti": 15, "expandstr": 32, "expans": [27, 31], "expect": [26, 30, 39], "expected_return_cod": 26, "expir": 42, "explicit": [20, 26, 34, 41], "explicitli": [29, 36], "export": [8, 32, 39], "expos": 29, "express": [26, 32], "extens": [4, 19, 20, 37], "extern": 35, "extra": [20, 26, 34, 41], "extract": 15, "f": [26, 30], "f580": 26, "f8e94fba1bd8": 26, "facil": 39, "fact": [2, 37, 49], "fact_path": 4, "facter": 4, "facter_": 4, "factor": [29, 40], "fail": [8, 10, 12, 14, 15, 20, 26, 29, 30, 33, 34, 40, 41], "failed_update_count": 40, "failed_when": 29, "failov": 35, "failur": [26, 29, 33, 34, 40], "failure_act": [33, 34], "failure_action_on_non_crash_failur": 33, "failure_actions_on_non_crash_failur": 34, "failure_command": [33, 34], "failure_hresult_cod": 40, "failure_msg": 40, "failure_reboot_msg": [33, 34], "failure_reset_period": 34, "failure_reset_period_sec": [33, 34], "fals": [4, 6, 7, 8, 10, 12, 13, 14, 15, 17, 19, 20, 24, 25, 26, 29, 32, 33, 34, 35, 36, 37, 39, 40, 41, 42], "famili": 1, "fashion": 27, "favor": 21, "favour": 34, "fb95c1c8": 40, "fcmssql01": 35, "fd3351d55421": 40, "featur": [2, 7, 9, 15, 30, 40, 49], "feature_result": 17, "featurenam": 24, "fed": 7, "fetch": [5, 12, 39], "few": [15, 40], "ffff": 26, "field": [1, 5, 8, 9, 10, 12, 13, 14, 15, 16, 17, 19, 20, 21, 23, 24, 26, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44, 45], "file": [1, 2, 4, 6, 8, 9, 11, 12, 14, 15, 16, 17, 25, 26, 27, 29, 31, 32, 35, 36, 40, 41, 44, 49], "file_copi": 10, "file_info": 37, "file_typ": [8, 19], "filenam": [10, 19, 20, 37, 41], "filesystem": [10, 19, 20, 26, 37, 41, 44], "filesystemright": 7, "filter": [9, 29, 36, 40, 50], "filtered_reason": 40, "filtered_upd": 40, "final": [3, 12], "finalis": 26, "find": [16, 19, 33, 39], "finish": [1, 26, 29, 44], "fire": 33, "firewall_port_open": 33, "first": [1, 14, 19, 34, 39], "fix": [12, 14], "flag": [7, 10, 15, 33, 42, 45], "float": [19, 20, 30, 37, 41, 44], "folder": [7, 9, 10, 12, 18, 19, 32, 37], "folder_info": 37, "follow": [1, 3, 5, 7, 8, 9, 10, 12, 13, 14, 15, 16, 17, 19, 20, 21, 23, 24, 26, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44, 45, 46], "follow_redirect": [20, 26, 41], "foo": [9, 10, 18, 29, 36, 37, 41], "forc": [1, 9, 10, 20, 26, 29, 30, 34, 36, 39, 40, 41], "force_basic_auth": [20, 26, 41], "force_dependent_servic": 34, "forest": 14, "forest_mod": 14, "form": [3, 8, 9, 15, 19, 31, 34, 36, 37, 40, 41, 43, 45], "format": [3, 9, 10, 29, 31, 32, 39, 42, 45], "forward": 37, "found": [19, 26, 33, 37, 39, 40], "found_update_count": 40, "framework": 17, "free": [9, 15, 36], "free_form": [15, 36], "from": [1, 2, 4, 6, 8, 9, 10, 12, 13, 14, 15, 17, 18, 19, 21, 24, 26, 28, 29, 30, 32, 33, 34, 36, 39, 40, 41, 42, 43, 45, 49], "ftp": [2, 10, 41, 49], "full": [1, 19, 20, 29, 31, 35, 37, 40, 42], "fullcontrol": 7, "fulli": [12, 14], "fullnam": [29, 42], "fully_qualified_error_id": 29, "fullyqualifiederrorid": 29, "function": [14, 32, 34, 39], "further": [17, 35, 40], "futher": 34, "futur": [34, 42], "g": [4, 7, 15, 19], "galaxi": [1, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44, 45], "galushko": 6, "gather": [2, 34, 49], "gather_fact": 13, "gather_subset": 4, "gather_timeout": 4, "ge": 29, "gener": [2, 8, 20, 26, 27, 29, 32, 33, 41], "get": [1, 2, 3, 6, 7, 10, 11, 12, 15, 17, 18, 19, 20, 24, 25, 26, 29, 30, 32, 33, 35, 39, 40, 41, 49], "get_checksum": [19, 37], "get_siz": 37, "get_url": 20, "getencod": [9, 36], "github": 40, "give": 29, "given": [4, 7, 9], "global": [1, 27, 35], "gmsa": 34, "go": [10, 30, 40], "goe": 36, "goldstein": 35, "good": 34, "govern": 43, "gpo": 43, "grant": 34, "greater": [15, 19, 26], "group": [2, 6, 13, 18, 25, 33, 34, 37, 40, 42, 43, 45, 49], "group_polici": 33, "groups_act": 42, "guarante": 27, "guest": 43, "guid": [12, 26, 33, 40], "guidanc": 40, "gurante": 30, "h": [26, 42], "h0nig": [6, 7, 25, 35], "ha": [1, 8, 10, 12, 13, 14, 15, 16, 19, 20, 26, 29, 30, 31, 33, 34, 35, 39, 40], "had": 17, "han": [6, 7, 25, 35], "handl": 40, "happen": [28, 44], "hard": [19, 37], "hash": 20, "have": [3, 6, 9, 10, 15, 16, 20, 26, 27, 29, 30, 32, 34, 36, 40, 41, 42, 46], "hawkesworth": [10, 16, 18, 39], "head": [20, 26, 41], "header": [20, 26, 39, 41], "hello": [29, 32], "help": [10, 29], "help_link": 29, "here": [0, 1, 2, 5, 8, 9, 10, 12, 13, 14, 15, 16, 17, 19, 20, 21, 23, 24, 26, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44, 45, 47], "hex": [8, 31, 32, 39], "hh": 42, "hh830471": 35, "hhmm": 42, "hidden": [15, 19, 37, 40], "high": [3, 45], "higher": [3, 14, 29], "highest": 15, "highli": 43, "hinden": [7, 15, 17, 26], "histor": 34, "hit": 41, "hive": [31, 32], "hkcc": 32, "hkcr": 32, "hkcu": [7, 15, 26, 32], "hkey_current_us": 15, "hkey_us": 32, "hklm": [6, 26, 31, 32], "hku": 32, "hlnk_target": [19, 37], "hoc": 36, "hoffman": [22, 34], "home": [9, 10, 42], "home_directori": 42, "homedir": 36, "homedir_out": 36, "homogen": 39, "host": [1, 2, 3, 5, 8, 9, 14, 15, 19, 20, 21, 23, 26, 27, 28, 29, 30, 33, 34, 35, 37, 39, 40, 41, 42, 44, 49], "host_err": 29, "host_out": 29, "hostnam": [13, 15, 23, 44], "hotkei": 32, "hour": [19, 40], "how": [8, 9, 20, 26, 29, 32, 33, 40, 41], "howev": 27, "hr": 35, "hresult": [29, 40], "hsot": 13, "html": 4, "http": [2, 4, 7, 8, 9, 10, 12, 15, 17, 26, 29, 30, 32, 33, 35, 36, 40, 41, 43, 45, 49], "http_agent": [20, 26, 41], "http_output": 41, "httpd": 10, "httpget": [20, 26, 41], "hwo": 15, "i": [1, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44, 45], "icmp": 28, "id": [1, 17, 26, 29, 34, 39, 40, 45], "idempot": [26, 34, 36], "ident": [7, 8], "identifi": [1, 7, 20, 26, 29, 33, 41, 42, 45], "idx": 29, "ie": [20, 26, 27, 41], "ifc": 12, "ifm": 12, "ignor": [9, 13, 17, 26, 27, 29, 33, 34, 36, 44], "ii": [8, 15, 17, 30], "iis_instal": 30, "iis_iusr": 7, "illustr": 8, "im": 2, "immedi": [18, 44], "imperson": 45, "impersonation_level": 45, "impli": 35, "implicit": 29, "import": [7, 8, 16, 34], "improv": 10, "includ": [1, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44, 45], "include_management_tool": 17, "include_par": 24, "include_sub_featur": 17, "incorrectli": [10, 39], "increas": [29, 40], "increment": 33, "indend": 9, "index": 29, "indic": [1, 6, 10, 15, 17, 25, 26, 30, 45], "individu": [4, 27], "induc": 28, "inetpub": [7, 15], "infinit": [20, 26, 34, 41], "info": [19, 26, 29, 33], "inform": [2, 4, 5, 6, 7, 10, 12, 13, 14, 15, 18, 19, 25, 26, 29, 30, 32, 34, 39, 40, 49], "inherit": [2, 7, 18, 49], "inheritanceflag": 7, "inheritonli": 7, "ini": [5, 26, 37], "init": 44, "initi": [4, 20, 26, 30, 41], "inlin": 39, "inner": 29, "inner_except": 29, "inorangestyle": 6, "input": [29, 36], "inputapp": 26, "insensit": [27, 40], "insid": 10, "instal": [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 18, 19, 20, 21, 22, 23, 24, 25, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 41, 42, 43, 44, 45, 49], "install_dn": [12, 14], "install_media_path": 12, "installdir": 26, "installdn": 12, "installed_update_count": 40, "instanc": 9, "instead": [6, 7, 9, 10, 12, 13, 14, 17, 18, 19, 20, 22, 26, 28, 29, 30, 34, 36, 37, 38, 39, 40, 41, 42], "int": 33, "int32": 26, "integ": [1, 4, 9, 10, 17, 19, 20, 26, 29, 33, 36, 37, 40, 41, 44, 45], "integr": [14, 20], "interact": [2, 20, 27, 33, 34, 40, 43, 49], "interepret": 29, "interfacealia": 11, "intermedi": 8, "intern": [4, 7, 35, 40, 41], "interpol": 39, "interpret": [29, 36], "interv": 40, "invalid": [12, 43], "invoc": [15, 29, 32], "invok": [2, 29, 49], "ip": [17, 24, 44], "ip_address": 11, "ipaddress": 15, "ipv4": 11, "ipv4_address": 11, "ipv6": 11, "irc": 2, "isarch": [19, 37], "isdir": [19, 37], "ishidden": [19, 37], "isjunct": [19, 37], "islnk": [19, 37], "iso": [15, 17, 29, 45], "isreadonli": [19, 37], "isreg": [19, 37], "isshar": [19, 37], "issu": [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44, 45], "item": [7, 15, 26, 29, 33, 36], "itemtyp": [29, 36], "its": [15, 20, 26, 29, 30, 33, 34], "itself": [10, 29], "j2": 39, "java": 44, "javascript": 41, "jborean93": [2, 3, 8, 10, 19, 26, 29, 31, 32, 33, 43, 44, 45], "jdk1": 16, "jhawkesworth": [10, 16, 18, 39], "jid": 1, "jinja": 39, "jinja2": 39, "joachim": [6, 7, 25, 35], "job": 1, "job_result": 1, "joe": 35, "join": [13, 43], "join_clust": [9, 36], "jon": [10, 16, 18, 39], "jordan": [2, 3, 8, 10, 19, 26, 29, 31, 32, 33, 43, 44, 45], "josh": 32, "joshludwig": 32, "jpg": 20, "json": [4, 29, 31, 41], "judgement": 36, "junction": [7, 19, 37], "just": [26, 28, 30, 40], "k": [19, 33, 34], "kb": [17, 40], "kb2858728": 26, "kb3004365": 40, "kb4056892": 40, "kb4073117": 40, "keech": 32, "keep": [10, 34], "kei": [1, 2, 3, 5, 6, 7, 8, 9, 10, 12, 13, 14, 15, 16, 17, 19, 20, 21, 23, 24, 26, 28, 29, 30, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44, 45, 49], "kerbero": [8, 20, 26, 41], "kernel_driv": 33, "key1": 3, "key2": 3, "key_export": 8, "key_storag": 8, "keyboard": 32, "keyword": 1, "keyword_al": 33, "keyword_ani": 33, "kilo": 19, "kit": 40, "kliemeck": [6, 7, 25, 35], "known": [8, 34, 35], "kuramochi": 20, "l": [9, 36], "label": [14, 45], "languag": [32, 39], "larg": [10, 19], "larger": [4, 10, 19], "last": [16, 19, 20, 30, 34, 37, 43], "lastaccesstim": [19, 37], "lastbootuptim": 30, "lastwritetim": [19, 37], "latest": [4, 15], "launch_protect": 33, "layout": 32, "lcm": 15, "ldap": 8, "lead": 39, "learn": 43, "least": [5, 34], "leav": 13, "less": [14, 19], "letter": 19, "level": [14, 16, 19, 27, 29, 33, 45], "libera": 2, "librari": [7, 8, 35, 40, 45], "licat": 26, "like": [5, 9, 16, 20, 27, 29, 31, 32, 34, 35, 39, 43, 45], "limbo": [30, 40], "limit": [4, 29], "line": [3, 9, 18, 29, 33, 36, 39], "linux": [24, 39], "list": [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44, 45, 49], "listen": 15, "liter": 3, "literalpath": 15, "lnk_sourc": [19, 37], "lnk_target": [19, 37], "load": [32, 33, 34, 36, 40, 41], "load_order_group": [33, 34], "local": [2, 4, 8, 10, 12, 13, 14, 15, 20, 26, 32, 34, 38, 40, 43, 44, 45, 49], "local_admin_password": 12, "local_follow": 10, "localhost": [15, 29], "localmachin": [7, 8], "localservic": 34, "localservicenonetwork": 34, "localsystem": 34, "locat": [2, 8, 20, 26, 29, 35, 38, 39, 49], "lock": 42, "lockstep": 1, "log": [11, 12, 14, 16, 19, 20, 26, 27, 29, 34, 37, 40, 41, 43, 44], "log_path": [11, 12, 14, 26, 40], "login": [20, 26, 41, 42], "login_domain": 45, "login_script": 42, "login_tim": 45, "logon": [30, 45], "logon_flag": 26, "logon_id": 45, "logon_serv": 45, "logon_typ": [26, 45], "logpath": 12, "london": 12, "long": [20, 26, 36, 40, 41, 42], "long_cmd": 1, "look": [19, 32, 39, 44], "lookup": [2, 21, 23, 26, 43, 49], "loop": 1, "lot": [19, 30], "low": 3, "lower": [3, 14, 30], "lsa": 45, "lstrip_block": 39, "ludwig": 32, "m": [19, 26, 28, 42], "machin": [2, 8, 10, 15, 16, 17, 26, 27, 39, 40, 49], "made": [12, 13, 14, 29], "mai": [4, 8, 9, 12, 13, 14, 26, 27, 29, 30, 34, 36, 40], "main": [9, 36], "major": [12, 29], "make": [8, 10, 30, 34, 42], "malici": 40, "manag": [2, 11, 14, 15, 16, 17, 18, 22, 26, 28, 30, 33, 36, 40, 45, 49], "managed_serv": 40, "mandatori": 45, "mani": [4, 20, 26, 29, 40, 41], "manipul": 18, "manual": [9, 26, 33, 34, 35], "mark": [29, 39], "marker": 39, "master": 40, "match": [3, 19, 29, 33, 40, 44], "matrix": 2, "matt": [2, 9, 11, 12, 13, 14, 27, 30, 36, 40], "maximum": [19, 30, 44], "maximum_redirect": [20, 26, 41], "md5": [19, 20, 37], "md5_checksum": 37, "mean": [9, 15, 16, 20, 26, 27, 36, 40, 41], "mechan": [10, 12, 41], "media": 12, "mega": 19, "member": [2, 13, 14, 21, 34, 42, 45, 49], "member_serv": 12, "membership": [2, 12, 14, 22, 40, 42, 43, 45, 49], "memori": 5, "mention": 27, "messag": [17, 20, 29, 30, 33, 34, 36, 40], "message_data": 29, "meta": 3, "metadata": 45, "method": [15, 20, 26, 29, 41, 45], "microsoft": [7, 8, 9, 12, 13, 14, 15, 24, 26, 29, 30, 31, 35, 36, 40, 43, 45], "might": 30, "millisecond": [33, 34], "min": 4, "minimum": 30, "minor": [16, 27], "minut": 19, "mismatch": 34, "miss": 45, "mitig": [30, 40], "mje3oqo": 5, "mkdir": 34, "mm": 42, "mode": [1, 12, 14, 26, 29, 32, 34, 40, 42], "modif": [18, 19, 37, 39], "modifi": [1, 2, 7, 18, 20, 27, 29, 32, 35, 42, 49], "modul": 50, "module_vers": 15, "more": [4, 7, 8, 9, 10, 12, 13, 14, 15, 19, 20, 26, 29, 30, 32, 33, 37, 40], "most": [15, 26, 34], "mostli": 29, "mous": 32, "mousetrail": 32, "move": [12, 13, 14, 27], "msbuild": 26, "msdn": [7, 8, 35, 45], "msft_smbshare": 35, "msg": [5, 9, 20, 30, 34, 36], "msi": [3, 26], "msiexec": 26, "msix": 26, "msixbundl": 26, "msp": 26, "mssql": 35, "mtime": 19, "much": 9, "multi": [32, 36], "multi_string_properti": 31, "multilin": 44, "multipl": [6, 10, 11, 15, 16, 19, 24, 26, 27, 33], "multistr": 32, "must": [5, 7, 8, 10, 14, 15, 16, 20, 26, 29, 30, 34, 35, 36, 39, 40, 41], "mutual": [9, 29], "my": [1, 3, 7, 8, 9, 15, 17, 20, 26, 33, 41], "my_ansible_var": 16, "mycompani": 32, "mydomaincli": 13, "myfil": 10, "myjavath": 27, "mysit": 7, "mytempl": 39, "mywg": 13, "n": [29, 39], "name": [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44, 45, 49], "named_pipe_ev": 33, "namespac": 29, "ndp451": 26, "ne": 30, "necessari": [6, 12, 13, 26, 30, 34], "need": [1, 8, 9, 15, 16, 19, 26, 27, 29, 30, 34, 35, 36, 40], "neg": 19, "negoti": [20, 26, 41, 45], "nerror": 29, "net": [16, 17, 24, 26, 29], "netbio": 14, "netcredentials_onli": 26, "netfx3": 24, "netlogon": [30, 34], "netsvc": 33, "network": [2, 8, 11, 26, 30, 34, 40, 45], "networkservic": 34, "never": 42, "new": [12, 14, 16, 22, 27, 29, 32, 34, 35, 36, 40], "new_credenti": 26, "newer": [2, 9, 11, 15, 19, 26, 29, 35, 39], "newli": [34, 42], "newlin": 39, "newline_sequ": 39, "newlocaladmin": 21, "next": [30, 42], "nitzmahon": [2, 9, 11, 12, 13, 14, 27, 30, 36, 40], "nline": 29, "nlink": [19, 37], "no_log": [15, 29], "no_profil": 36, "node": [2, 3, 10, 15, 29, 33, 36, 39, 41, 49], "non": [9, 10, 12, 14, 18, 19, 20, 22, 24, 28, 30, 34, 36, 37, 38, 41, 42, 45], "none": [1, 3, 7, 20, 26, 29, 32, 33, 34, 35, 41], "nonexist": 10, "noprofil": 36, "nopropagateinherit": 7, "norestart": 26, "normal": [1, 19, 29, 33, 34, 37], "note": [12, 37], "noth": 44, "notif": 34, "notifi": [16, 27], "notin": 15, "notskip": 17, "notspecifi": 29, "now": 42, "nt": [21, 33, 34, 43], "ntd": [8, 12, 14], "ntlm": [20, 26, 41], "ntuser": 32, "nuget": 10, "null": [16, 19, 29, 32, 33, 34], "numa": 33, "number": [19, 26, 30, 32, 33, 37, 40, 41, 44], "numer": [39, 41], "o": [1, 17, 40], "object": [13, 15, 29, 36, 37, 42], "objectinherit": 7, "obsolet": 26, "obtain": [2, 31, 37, 49], "occur": [15, 17, 20, 26, 29, 41], "octob": 42, "od": 39, "off": 16, "offici": [1, 4, 5, 9, 10, 12, 13, 14, 17, 18, 20, 21, 22, 24, 26, 28, 30, 31, 32, 34, 36, 37, 38, 39, 40, 41, 42, 44, 45], "offlin": 44, "offset": 29, "ok": [20, 41], "old_hostnam": 23, "old_nam": 23, "older": [9, 11, 19, 29], "oleg": 6, "omit": [16, 26, 33, 34, 42], "on_creat": [34, 42], "onc": [8, 16, 33], "one": [10, 13, 19, 24, 26, 29, 30, 32, 40], "ones": [20, 26, 34, 41], "onli": [4, 8, 9, 10, 11, 12, 13, 14, 15, 17, 19, 20, 21, 26, 29, 32, 33, 34, 35, 36, 37, 39, 40, 41, 42, 44, 45], "onlin": [15, 40], "onlineport": 15, "open": 44, "openssl": 8, "oper": [1, 9, 10, 14, 15, 21, 29, 33, 34, 40], "option": [1, 2, 6, 8, 9, 10, 12, 15, 16, 19, 20, 26, 29, 30, 32, 34, 36, 39, 40, 41, 42, 44, 49], "order": [3, 11, 27, 33, 34, 39], "org": 32, "origin": [5, 10, 20, 23, 26, 39, 41], "original_basenam": 10, "other": [1, 8, 9, 12, 19, 20, 21, 26, 27, 29, 32, 33, 34, 37, 41, 42, 43], "otherwis": [8, 10, 26, 34], "ou": 13, "out": [2, 15, 16, 19, 20, 26, 27, 32, 33, 41, 49], "out_": 19, "output": [1, 9, 12, 15, 29, 30, 32, 36, 39, 41], "output_encod": 39, "output_encoding_overrid": [9, 36], "outsid": 1, "over": [10, 12, 26], "overrid": [3, 9, 19, 26, 36, 39], "own": [26, 30, 42], "owner": [2, 7, 18, 19, 37, 39, 45, 49], "ownership": 18, "p": 33, "p7b": 8, "pack": 40, "packag": [2, 17, 24, 40, 45, 49], "packagefullnam": 26, "pair": 29, "panel": [11, 32], "param": 29, "parameterbindingfail": 29, "paramt": 12, "parent": [6, 10, 24], "pars": 3, "part": [1, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44, 45], "parti": [8, 26], "particip": 40, "particular": [4, 32, 34, 40], "pass": [3, 10, 13, 20, 29, 30, 32], "passiv": 26, "password": [8, 12, 13, 14, 20, 26, 29, 34, 41, 42], "password123": [12, 13, 14], "password_expir": 42, "password_never_expir": 42, "patch": 26, "patchcod": 26, "path": [1, 2, 4, 5, 6, 7, 8, 9, 10, 12, 13, 14, 15, 16, 18, 19, 20, 25, 26, 29, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 44, 49], "pattern": [9, 19, 29, 36], "paul": [17, 20, 42], "paus": [33, 34], "pause_continu": 33, "pause_pend": 33, "pc": 42, "pem": 8, "pend": [20, 26, 33, 41], "peopl": 8, "per": 1, "perform": [10, 15, 33, 34, 40, 41], "period": [33, 34], "perman": 26, "permiss": [2, 6, 10, 18, 25, 35, 37, 49], "persist": 26, "person": [8, 20, 26, 41], "pfx": [8, 20, 26, 41], "phil": 7, "physic": 11, "physicalpath": 15, "pick": [16, 27], "ping": [2, 49], "pipe": [26, 33], "pipelin": 29, "pipeline_iteration_info": 29, "pkcs12": 8, "place": [10, 12], "plai": [13, 29], "plain": 42, "platform": 1, "playbook": [1, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44, 45], "playbooks_deleg": 4, "pleas": [4, 10, 22, 38], "plugin": [1, 3, 10, 30, 39, 40, 46], "point": [19, 26, 33, 37], "polici": [30, 43], "poll": [1, 20, 40, 44], "pong": 28, "port": [15, 41, 44], "possibl": [13, 15, 36, 40, 42], "possibli": 1, "post": 41, "post_reboot_delai": 30, "post_reboot_delay_sec": 30, "powershel": [2, 3, 9, 12, 17, 19, 20, 24, 26, 27, 36, 39, 40, 41, 49], "pr": 26, "practic": 36, "pre_reboot_delai": 30, "pre_reboot_delay_sec": 30, "pre_shutdown_timeout": 34, "pre_shutdown_timeout_m": [33, 34], "predict": [1, 36], "prefer": [33, 39], "preferred_nod": 33, "prefix": [4, 32, 38, 43], "present": [6, 7, 8, 15, 16, 17, 18, 21, 22, 24, 26, 27, 29, 32, 34, 35, 42, 44], "preserv": [27, 34], "preshutdown": [33, 34], "prevent": [8, 20, 26, 39, 41, 42], "previous": 35, "primari": 45, "princip": 45, "print": [5, 39], "prioriti": 3, "privat": [7, 8], "privileg": [30, 32, 33, 34, 45], "probabl": 16, "proce": 34, "process": [2, 3, 8, 9, 16, 26, 29, 33, 36, 39, 40, 44, 49], "process_id": 33, "product": 26, "product_id": 26, "productcod": 26, "profil": [32, 36, 42], "program": [4, 5, 9, 16, 26, 27, 31, 35], "program_conf": 5, "programdir": 31, "progress": [33, 40], "promot": 12, "prompt": 30, "propag": 7, "propagationflag": 7, "proper": 26, "properli": [20, 26, 41], "properti": [19, 26, 30, 31, 32], "protect": [8, 20, 26, 30, 33, 41, 43], "protocol": 15, "provid": [4, 15, 19, 26, 28, 29, 32, 35], "proxi": [20, 26, 41], "proxy_password": [20, 26, 41], "proxy_url": [20, 26, 41], "proxy_use_default_credenti": [20, 26, 41], "proxy_usernam": [20, 26, 41], "ps1": [4, 19, 36, 37], "pscmdlet": 29, "pscredenti": [15, 29], "psdscrunascredenti": 15, "psdscrunascredential_password": 15, "psdscrunascredential_usernam": 15, "psexec": [9, 36], "psversion": 29, "psversiont": 29, "public": 35, "publish": 8, "pure": 21, "purpos": [8, 27, 29], "pwsh": 29, "pwsh_output": 29, "python": 39, "q": 26, "qn": 26, "qualifi": [12, 14], "queri": [2, 33, 42, 45, 49], "question": [2, 15], "quietuninstallstr": 26, "quot": [2, 9, 10, 26, 27, 33, 48], "qword": 32, "r": 39, "r2": [17, 40], "rabbit": [9, 36], "rabbitmqctl": [9, 36], "rais": 29, "ram": 5, "ran": 29, "randomus": 20, "rare": [9, 36], "raw": [9, 19, 29, 31, 36, 37, 39, 41], "raw_valu": 31, "rc": [9, 26, 29, 36], "rcanderson23": 24, "rdcman": 26, "re": [23, 30], "reachabl": 14, "read": [4, 7, 8, 12, 19, 26, 35, 37], "read_onli": 12, "readi": [19, 30, 37], "readtoend": 36, "real": 20, "reason": [17, 29, 40], "reboot": [2, 12, 13, 14, 15, 17, 23, 24, 26, 33, 34, 40, 49], "reboot_requir": [12, 13, 14, 15, 17, 23, 24, 26, 30, 40], "reboot_timeout": [30, 40], "reboot_timeout_sec": 30, "receiv": 18, "recent": 20, "recommend": [10, 19, 26, 29, 40, 43], "recommended_act": 29, "record": 29, "recurs": [10, 18, 19, 25, 39], "redirect": [20, 26, 41], "refer": [14, 17, 31], "referenc": [9, 29, 36], "reflect": [29, 42], "reg": 15, "reg_binari": 31, "reg_expand_sz": 31, "reg_multi_sz": 31, "reg_non": 31, "reg_sz": 31, "regardless": 35, "regedit": [32, 39], "regex": [19, 40, 44], "regexp": [19, 44], "regist": [1, 5, 9, 12, 13, 14, 17, 23, 24, 29, 30, 31, 33, 36, 37, 41], "registri": [2, 6, 15, 18, 25, 26, 37, 49], "registryright": 7, "regular": [19, 37], "reject_list": 40, "rel": [10, 19, 27, 29, 37, 39], "relat": [12, 24], "releas": [4, 12, 29, 30, 35], "reliabl": 30, "relianc": 35, "remain": [19, 37], "remot": [2, 3, 19, 20, 21, 26, 29, 30, 33, 36, 37, 40, 43, 49], "remote_src": 10, "remov": [2, 6, 7, 8, 9, 12, 13, 14, 16, 17, 21, 25, 26, 27, 29, 31, 34, 35, 36, 37, 39, 40, 41, 42, 43, 44, 49], "renam": 10, "render": 39, "reorgan": 6, "repeat": 34, "replac": [8, 20, 30, 34, 35, 39, 42, 43], "replica": 12, "report": [33, 34, 41], "repositori": [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44, 45], "repres": [19, 26, 29, 32, 33, 37], "represent": 29, "request": [20, 26, 27, 41], "requir": [1, 3, 5, 6, 7, 8, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 29, 30, 31, 32, 33, 34, 36, 37, 39, 40, 41, 42, 43, 45], "required_privileg": [33, 34], "reset": [33, 34, 40], "resid": 14, "resolv": 44, "resourc": [8, 15, 20, 35], "resource_nam": 15, "respect": [3, 29], "respond": 30, "respons": [20, 26, 41], "restart": [16, 27, 33, 34, 40], "restart_need": 17, "restrict": [4, 7, 8, 19, 33, 34], "result": [4, 9, 10, 17, 20, 26, 27, 29, 30, 39, 40, 41], "retri": [1, 44], "retriev": [5, 20, 36, 42], "return": [2, 4, 49], "return_cont": 41, "reveal": 29, "revis": 26, "revok": 8, "right": [2, 7, 34, 45, 49], "ripon": 23, "riponbanik": 23, "role": [17, 35], "rollup": 40, "room": 2, "root": [8, 14, 25, 32], "rpc_interface_ev": 33, "rpcss": 33, "rule": [3, 7, 9, 40], "rule_act": 35, "run": [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44, 45, 49], "run_command": [33, 34], "run_onc": 1, "runa": [8, 26, 40], "runm": 33, "runs_in_system_process": 33, "safe": [12, 14, 16, 20, 26, 41], "safe_mode_password": [12, 14], "sai": 9, "same": [9, 10, 14, 19, 26, 27, 29, 37, 40, 45], "sampl": [1, 5, 8, 9, 10, 12, 13, 14, 15, 16, 17, 19, 20, 21, 23, 24, 26, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44, 45], "sapwd": 26, "saraceni": 21, "satisfi": 27, "save": [9, 20, 32], "scalar": 40, "scan": [19, 26], "sccm": 40, "scenario": 9, "schedul": [30, 40], "scholer": [11, 16], "schwartz": 7, "schwartzmx": 7, "scm": 33, "scmanag": 34, "scope": [27, 35], "scope_nam": 35, "scratch": 29, "screen": 30, "script": [2, 7, 15, 36, 42, 44, 49], "script_stack_trac": 29, "scriptblock": 29, "search": [8, 10, 19, 26, 31, 40, 44], "search_regex": 44, "sebackupprivileg": [32, 33, 34], "sebatchlogonright": 45, "sechangenotifyprivileg": 45, "second": [4, 13, 19, 20, 26, 30, 33, 34, 37, 40, 41, 44], "secreatesymboliclinkprivileg": 43, "secret": [6, 35], "section": [26, 39], "secur": [7, 8, 9, 30, 36, 40, 42, 43], "securestr": 29, "securityanonym": 45, "securityupd": 40, "sedebugprivileg": 45, "sedenyinteractivelogonright": 43, "sedenyremoteinteractivelogonright": 43, "see": [8, 15, 35], "seen": [26, 29], "seinteractivelogonright": 45, "select": [9, 15, 19, 26, 40], "self": [20, 26, 41], "send": [9, 10, 20, 26, 34, 41], "senetworklogonright": 45, "sensit": 29, "sensitive_paramet": 29, "sensitive_valu": 29, "sent": [20, 26, 29, 41], "separ": [7, 10, 15, 17, 26, 30, 32, 35, 41, 42], "sequenc": 39, "seremoteinteractivelogonright": 45, "seremoteshutdownprivileg": [30, 45], "serestoreprivileg": [32, 33, 34], "serial": [1, 29], "server": [2, 10, 11, 13, 14, 15, 20, 24, 26, 30, 33, 35, 40, 41, 43, 44, 45, 49], "server_select": 40, "serveraliveinterv": 40, "servernam": [21, 43], "servic": [2, 8, 10, 12, 14, 20, 21, 26, 29, 30, 36, 40, 41, 43, 44, 49], "service1": 34, "service2": 34, "service_change_config": 34, "service_enumerate_depend": 34, "service_exit_cod": 33, "service_flag": 33, "service_info": 33, "service_query_config": 34, "service_query_statu": 34, "service_typ": [33, 34], "seservicelogonright": [34, 43], "session": 45, "set": [2, 3, 4, 6, 8, 9, 10, 11, 12, 13, 14, 15, 16, 18, 19, 20, 23, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 39, 40, 41, 42, 43, 44, 45, 46, 49], "settl": [30, 34, 40], "setup": [2, 15, 26, 49], "sever": [16, 33, 34], "sha1": [10, 19, 20, 37], "sha1_checksum": 37, "sha256": [19, 20, 37], "sha256_checksum": 37, "sha256sum": 20, "sha384": [19, 20, 37], "sha512": [19, 20, 37], "shachaf": 35, "shachaf92": 35, "share": [2, 17, 19, 24, 26, 37, 39, 49], "share01": 24, "sharenam": [19, 37], "shell": [2, 9, 29, 48, 49], "short": 31, "should": [4, 6, 8, 9, 10, 12, 13, 14, 15, 16, 20, 25, 26, 27, 32, 34, 35, 36, 38, 39, 40, 41, 42], "shouldprocess": 29, "show": [15, 33, 40], "shown": [15, 30, 43], "shutdown": [30, 33, 34], "sid": [33, 34, 42, 45], "sid_info": [33, 34], "sideload": 26, "sign": [20, 26, 29, 41], "signal": 40, "signifi": 41, "signific": 40, "silently_continu": 29, "silentlycontinu": 29, "similar": [18, 36, 40], "simpl": [6, 10], "sinc": [19, 20, 26, 37, 40, 41, 42], "singl": [3, 10, 11, 14, 17, 19, 26, 27, 30, 33], "site": [12, 20, 26, 41], "site_nam": 12, "size": [5, 10, 19, 20, 37, 41], "skip": [9, 17, 29, 36, 40, 41], "skip_hidden": 40, "skip_opt": 40, "skip_reason": 17, "slash": [20, 37], "slave1": [9, 36], "sleep": 44, "slightli": 30, "slow": 30, "slurp": [2, 49], "smadam813": 32, "smaller": 19, "smbshare": 35, "snapshot": 4, "so": [1, 3, 4, 9, 10, 15, 20, 30, 32, 39], "softwar": [6, 26, 31, 32, 40], "some": [1, 4, 8, 20, 26, 30, 32, 40, 41], "somedir": [9, 36], "somehow": [10, 39], "somelog": 36, "somescript": 36, "somesit": 41, "someth": 30, "sort": 19, "sourc": [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44, 45], "space": [3, 9, 26, 33, 36, 39], "spawn": [26, 36], "special": [39, 43], "specif": [2, 4, 9, 10, 14, 15, 16, 26, 29, 31, 33, 41, 49], "specifi": [1, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44, 45], "speed": 19, "split": [9, 26, 36], "spooler": 34, "sql": [26, 35], "sql2019": 26, "sqlbackup": 35, "sqlexpr_x64_enu": 26, "sqlexpress": 26, "src": [5, 7, 10, 20, 39], "srv": 10, "ssh": [20, 26, 40, 41], "ssl": [20, 26, 41], "sslflag": 15, "stack": 29, "stage": 40, "stamp": 18, "standard": [9, 15, 36], "start": [1, 9, 15, 20, 29, 30, 33, 34, 36, 39, 40, 44], "start_mod": [30, 33, 34], "start_pend": 33, "start_servic": 33, "startup": [30, 34], "stat": 37, "state": [2, 6, 7, 8, 11, 13, 14, 15, 16, 17, 18, 20, 21, 22, 24, 26, 27, 31, 32, 33, 34, 35, 38, 40, 41, 42, 44, 45, 49], "statement": [29, 39], "static": 11, "statu": [2, 20, 26, 29, 30, 34, 41, 49], "status_cod": [20, 41], "status_descript": 41, "stderr": [1, 9, 26, 29, 36], "stderr_lin": 9, "stdin": [9, 36], "stdout": [1, 9, 26, 29, 36], "stdout_lin": [9, 36], "step": 41, "still": [20, 26, 41, 42], "stop": [26, 29, 33, 34, 44], "stop_pend": 33, "stop_servic": 33, "store": [2, 16, 27, 41, 49], "store_loc": 8, "store_nam": 8, "store_typ": 8, "strategi": 1, "stream": [26, 29], "strftime": 42, "string": [1, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44, 45], "stringifi": 17, "strip": 39, "strongpassword": 8, "structur": [6, 18, 29, 36, 41], "style": [9, 39], "sub": [17, 31, 33], "sub_kei": 31, "sub_typ": 33, "sub_type_guid": 33, "subdirectori": 18, "subfeatur": 17, "subfold": 18, "subopt": 29, "subsequ": [12, 13, 14], "subset": 4, "subsystem": [17, 24], "subsytem": 24, "success": [1, 3, 4, 5, 8, 9, 10, 17, 19, 20, 21, 24, 26, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 40, 41, 43, 45], "successfulli": [20, 26, 30, 40], "suffix": [4, 15, 19, 38], "suit": 16, "summari": 41, "supersed": 26, "suppli": [4, 12, 19, 26, 34], "support": [1, 2, 6, 10, 11, 13, 17, 20, 26, 32, 34, 37, 39, 40, 41], "supportsshouldprocess": 29, "sure": [10, 20], "surviv": 40, "svc": 35, "svchost": [33, 34], "switch": [10, 12, 29], "sx": [17, 24], "symbol": [10, 19, 37, 43], "symlink": [7, 19, 37], "synchron": 40, "syntax": 19, "system": [2, 4, 5, 6, 8, 9, 15, 17, 18, 20, 21, 24, 25, 26, 27, 29, 30, 33, 34, 36, 37, 38, 39, 40, 43, 49], "system32": [16, 27, 33, 34], "systemroot": [12, 14, 27], "sysvol": [12, 14], "sysvol_path": [12, 14], "t": [8, 10, 16, 26, 39, 40, 43, 44], "tab": 39, "tag": [29, 39], "take": [5, 9, 15, 19, 23, 30, 33, 34, 36, 40], "taken": [10, 26], "takeshi": 20, "target": [1, 2, 3, 7, 9, 10, 12, 13, 14, 15, 17, 18, 19, 20, 21, 22, 24, 27, 28, 29, 30, 31, 34, 37, 38, 40, 41, 42, 49], "target_nam": 29, "target_object": 29, "target_typ": 29, "targetingpack": 26, "task": [2, 9, 10, 12, 13, 15, 20, 24, 26, 29, 30, 34, 36, 40, 41, 49], "tcp": [30, 44], "team": [1, 4, 5], "technet": 40, "tell": 4, "telnet": [15, 17], "temp": [8, 9, 10, 15, 17, 18, 19, 20, 26, 29, 34, 35, 36, 37, 38, 39, 44], "temp2": 15, "temp_fil": 10, "tempfil": 38, "templat": [1, 2, 4, 49], "template_destpath": 39, "template_fullpath": 39, "template_host": 39, "template_path": 39, "template_run_d": 39, "template_uid": 39, "temporari": [2, 26, 29, 49], "termin": 29, "test": [9, 15, 16, 28, 29, 30, 32, 34, 36, 42], "test_command": 30, "testdata": 15, "testgroup": 21, "testgui": [12, 13], "testus": 21, "testvalu": 15, "testvari": 16, "text": [9, 34, 36, 42], "than": [10, 14, 19, 20, 26, 39], "thei": [10, 14, 16, 18, 27, 29, 42], "them": [10, 34, 40], "therefor": [16, 27], "thi": [1, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44, 45, 50], "thing": 39, "thingi": 26, "third": 8, "those": [3, 9, 19, 26, 34, 40], "threat": [30, 43], "throttl": 1, "through": [9, 20, 26, 31, 40, 41], "throw": [8, 15, 19, 29, 37], "thu": 36, "thumbprint": [8, 20, 26, 41], "time": [9, 18, 19, 20, 26, 29, 30, 33, 34, 36, 37, 39, 40, 41, 44, 45], "time_gener": 29, "timeout": [4, 20, 26, 30, 33, 40, 41, 44], "timestamp": [10, 39, 42], "timezon": 42, "titl": 40, "tksarah": 20, "tmp": 10, "tmpdir": 29, "tofiletim": 30, "togeth": [19, 26, 34], "toggl": 32, "token": [29, 33, 34, 45], "token_typ": 45, "tokenimperson": 45, "tokenprimari": 45, "too": 10, "took": 10, "tool": [7, 17, 39, 40], "top": [26, 35], "touch": [2, 6, 7, 8, 25, 37, 49], "trace": 29, "traceback": 39, "tracker": [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44, 45], "tradit": [26, 29], "traffic": 35, "trail": [27, 32], "transfer": [10, 20, 39], "transport": 15, "treat": [29, 33], "tree": 10, "trend": 36, "trigger": [12, 13, 33], "trim": 36, "trim_block": 39, "trivial": 28, "trond": [7, 15, 17, 26], "trondhinden": [7, 15, 17, 26], "true": [4, 6, 7, 8, 9, 10, 12, 13, 14, 15, 17, 19, 20, 23, 24, 25, 26, 29, 30, 31, 32, 33, 34, 35, 36, 37, 39, 40, 41, 42, 44], "trust": 8, "trustedpeopl": 8, "trustedpublish": 8, "try": [9, 15, 30, 43, 44], "twice": [5, 30], "two": 26, "txt": [10, 11, 19, 20, 36, 37, 39, 40, 44], "type": [3, 5, 7, 8, 15, 19, 20, 21, 26, 29, 31, 32, 33, 34, 41, 45], "typic": [8, 14, 29], "u": [7, 8, 12, 15, 30, 35, 36, 40, 43, 45], "uid": 39, "uint32": 26, "un": 8, "unabl": [19, 37], "unauthor": 12, "unavail": [4, 40], "unc": [12, 14], "uncondition": 30, "under": [4, 7, 15, 26, 32, 36, 41], "underli": 29, "unexpand": 27, "unexpect": [30, 40], "uninstal": [2, 24, 40, 49], "uninstallstr": 26, "uniqu": [1, 5, 8, 9, 10, 12, 13, 14, 15, 16, 17, 19, 20, 21, 23, 24, 26, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44, 45], "unit": 19, "unix": 39, "unjoin": 13, "unknown": 35, "unless": [10, 20, 26, 29, 34, 36, 41], "unlik": [8, 18], "unlimit": 19, "unlock": 42, "unpaus": 34, "unread": 8, "unreli": 40, "unrestrict": [33, 34], "unset": 16, "unsign": 26, "until": [1, 13, 16, 17, 26, 30, 34, 36, 37, 40, 44], "unwanted_var": 16, "up": [1, 3, 4, 11, 15, 16, 19, 27, 29, 30, 34], "updat": [2, 17, 18, 19, 24, 26, 30, 32, 37, 42, 49], "update_password": [34, 42], "updaterollup": 40, "upgrad": 40, "upn": 45, "upnphost": 33, "upon": [20, 26, 41], "uri": [20, 26, 29, 41], "url": [20, 26, 41], "url_method": [20, 26, 41], "url_password": [20, 26, 41], "url_timeout": [20, 26, 41], "url_usernam": [20, 26, 41], "us": [1, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44, 45, 46], "usag": [2, 4, 8], "use_default_credenti": [20, 26, 41], "use_proxi": [20, 26, 41], "use_regex": 19, "user": [2, 6, 8, 9, 10, 12, 13, 15, 16, 18, 20, 21, 25, 26, 27, 30, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 49], "user_cannot_change_password": 42, "user_flag": 45, "user_guid": 4, "user_own_process": [33, 34], "user_share_process": [33, 34], "userflag": 45, "usernam": [12, 13, 20, 21, 26, 29, 33, 34, 41, 42], "usr": 4, "usual": [8, 11, 26], "utc": [29, 42], "utf": 39, "util": 40, "v1": [27, 40, 42], "v5": 29, "vagrant": [12, 13, 14], "valid": [9, 14, 15, 16, 20, 26, 30, 33, 36, 40, 41, 45], "validate_cert": [20, 26, 41], "valu": [2, 4, 11, 27, 49], "value1": 3, "value2": 3, "valuedata": 15, "valuenam": 15, "var": [3, 8, 10, 16, 26, 27, 37, 39, 40], "vari": 15, "variabl": [1, 2, 3, 4, 9, 13, 29, 39, 49, 50], "variable_end_str": 39, "variable_start_str": 39, "variou": [2, 8, 48], "varnam": 27, "vault": [10, 13], "vcredist_x64": 26, "verbos": [15, 29], "verbose_set": 15, "verbose_test": 15, "verboseprefer": 29, "veri": [9, 10, 16, 36], "verif": 30, "verifi": [15, 20], "versa": 6, "version": [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44, 45, 49], "veryhardpassword": 26, "verystrongpasswordher": 8, "via": [36, 39], "vice": 6, "view": 34, "virtual": 34, "visibl": 11, "visual": 26, "visualstudio": 26, "volum": 35, "vs_buildtool": 26, "vsu_4": 26, "vvv": 15, "w": 33, "wa": [10, 17, 19, 23, 26, 29, 30, 31, 33, 34, 35, 37, 39, 40], "wai": [3, 15, 16, 18, 30, 32, 39, 40], "wait": [1, 2, 13, 26, 30, 33, 34, 40, 49], "wait_attempt": 44, "wait_for": 44, "wait_for_children": 26, "wait_hint_m": 33, "want": [9, 18, 29, 30, 36], "warn": [15, 29], "warningprefer": 29, "wbadmin": 9, "we": [19, 40], "web": [7, 10, 17, 20, 26, 30, 41], "webrequest": 29, "webserv": 41, "webservic": [2, 20, 26, 49], "websit": 15, "week": 19, "were": [8, 12, 13, 14, 17, 29, 33, 35, 40, 43], "what": [1, 4, 26, 28, 29, 30, 34, 36, 42], "whatif": 29, "when": [1, 3, 8, 9, 10, 12, 13, 14, 16, 17, 19, 20, 21, 23, 24, 26, 27, 29, 30, 32, 33, 34, 35, 36, 39, 40, 41, 42, 44], "where": [8, 10, 11, 12, 14, 15, 16, 20, 26, 29, 38, 40, 41, 42, 43], "whether": [1, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44, 45], "which": [9, 10, 11, 12, 13, 14, 16, 17, 19, 20, 26, 27, 29, 32, 33, 34, 35, 36, 39, 40, 41, 44], "while": [18, 19, 29, 33, 34, 41], "whitelist": 40, "who": 43, "whoami": [9, 45], "whoami_out": 9, "whose": [11, 19], "why": [12, 13, 14, 40], "wide": 26, "wieer": [38, 41], "wiki": 32, "wikipedia": 32, "wildcard": [11, 19, 33], "win": 33, "win10": 24, "win2003": 14, "win2008": 14, "win2008r2": 14, "win2012": 14, "win2012r2": 14, "win32": [3, 9], "win32_exitcod": 33, "win32_operatingsystem": 30, "win32_own_process": [33, 34], "win32_share_process": [33, 34], "win_acl": [2, 6, 18, 25, 37, 49], "win_acl_inherit": [2, 7, 18, 49], "win_async": 12, "win_certificate_stor": [2, 49], "win_chocolatei": [17, 24, 26, 40], "win_command": [1, 2, 3, 29, 36, 49], "win_copi": [2, 18, 39, 49], "win_credenti": 45, "win_dns_client": [2, 23, 49], "win_domain": [2, 12, 13, 49], "win_domain_admin_password": 13, "win_domain_admin_us": 13, "win_domain_comput": [12, 13, 14], "win_domain_control": [2, 13, 14, 49], "win_domain_group": [12, 13, 14, 21, 22], "win_domain_membership": [2, 12, 14, 21, 42, 49], "win_domain_us": [12, 13, 14, 42], "win_dsc": [2, 49], "win_environ": [2, 27, 49], "win_featur": [2, 24, 30, 40, 49], "win_fil": [2, 6, 7, 25, 31, 37, 49], "win_find": [2, 49], "win_get_url": [2, 10, 41, 49], "win_group": [2, 13, 21, 42, 43, 49], "win_group_membership": [2, 13, 22, 42, 43, 45, 49], "win_hostnam": [2, 49], "win_hotfix": [26, 40], "win_inet_proxi": [20, 26, 41], "win_nssm": 34, "win_optional_featur": [2, 49], "win_own": [2, 7, 18, 37, 49], "win_p": [2, 49], "win_packag": [2, 17, 24, 40, 49], "win_path": [2, 16, 49], "win_powershel": [2, 36, 49], "win_psexec": [9, 36], "win_psmodul": 15, "win_reboot": [2, 12, 13, 14, 17, 23, 24, 40, 49], "win_reg_stat": [2, 32, 49], "win_regedit": [2, 26, 31, 49], "win_regmerg": [31, 32], "win_robocopi": 10, "win_servic": [2, 30, 33, 49], "win_service_info": [2, 34, 49], "win_shar": [2, 49], "win_shel": [2, 3, 9, 15, 29, 49], "win_stat": [2, 6, 7, 18, 25, 49], "win_tempfil": [2, 49], "win_templ": [2, 10, 18, 49], "win_upd": [2, 26, 49], "win_uri": [2, 20, 49], "win_us": [2, 13, 43, 49], "win_user_profil": 42, "win_user_right": [2, 34, 45, 49], "win_wait_for": [2, 49], "win_wait_for_process": 44, "win_whoami": [2, 49], "winclient": 13, "window": [0, 47, 50], "windows_light": 33, "windows_registri": 32, "windows_upd": 40, "windowsfeatur": [15, 17], "windowsoptionalfeatur": 24, "windowspowershel": 27, "winlogon": 45, "winnt": 42, "winrm": [10, 12, 20, 26, 30, 33, 34, 36, 41], "winserv": 28, "winthreshold": 14, "within": 15, "without": [1, 4, 8, 10, 12, 16, 26, 27, 34, 37, 40, 42], "wmi": 35, "wmpnetworksvc": 33, "won": 43, "word": 19, "work": [1, 5, 9, 15, 18, 20, 26, 30, 34, 36, 39, 40], "workgroup": [2, 12, 14, 21, 42, 49], "workgroup_nam": 13, "world": [29, 32], "would": 42, "wow6432nod": 26, "wrapper": [12, 26], "write": [3, 7, 9, 29, 35, 36, 39], "writeerrorexcept": 29, "writelin": 29, "written": [14, 29], "wsl_statu": 24, "wsman": [15, 29], "wsse": 41, "wsu": 40, "wu_e_no_interactive_us": 40, "www": [20, 41], "wwwroot": [7, 15], "x": [8, 26, 29], "x1": 39, "x509": [20, 26, 41], "x509certif": 8, "x509keystorageflag": 8, "x64": 26, "x86": 26, "xwebadministr": 15, "xwebsit": 15, "y": [26, 42], "yaml": [27, 32], "ye": 10, "yet": [30, 40], "you": [8, 9, 10, 12, 14, 15, 16, 18, 19, 20, 26, 30, 32, 34, 35, 36, 39, 40, 41, 43, 44], "your": [20, 30, 36], "yum": 1, "z": 42, "zero": 33, "zip": [15, 26], "zipfil": 15, "zollo": 35}, "titles": ["Collections in the Ansible Namespace", "ansible.windows.async_status module \u2013 Obtain status of asynchronous task", "Ansible.Windows", "ansible.windows.quote filter \u2013 Quotes argument(s) for various Windows shells", "ansible.windows.setup module \u2013 Gathers facts about remote hosts", "ansible.windows.slurp module \u2013 Slurps a file from remote nodes", "ansible.windows.win_acl_inheritance module \u2013 Change ACL inheritance", "ansible.windows.win_acl module \u2013 Set file/directory/registry/certificate permissions for a system user or group", "ansible.windows.win_certificate_store module \u2013 Manages the certificate store", "ansible.windows.win_command module \u2013 Executes a command on a remote Windows node", "ansible.windows.win_copy module \u2013 Copies files to remote locations on windows hosts", "ansible.windows.win_dns_client module \u2013 Configures DNS lookup on Windows hosts", "ansible.windows.win_domain_controller module \u2013 Manage domain controller/member server state for a Windows host", "ansible.windows.win_domain_membership module \u2013 Manage domain/workgroup membership for a Windows host", "ansible.windows.win_domain module \u2013 Ensures the existence of a Windows domain", "ansible.windows.win_dsc module \u2013 Invokes a PowerShell DSC configuration", "ansible.windows.win_environment module \u2013 Modify environment variables on windows hosts", "ansible.windows.win_feature module \u2013 Installs and uninstalls Windows Features on Windows Server", "ansible.windows.win_file module \u2013 Creates, touches or removes files or directories", "ansible.windows.win_find module \u2013 Return a list of files based on specific criteria", "ansible.windows.win_get_url module \u2013 Downloads file from HTTP, HTTPS, or FTP to node", "ansible.windows.win_group_membership module \u2013 Manage Windows local group membership", "ansible.windows.win_group module \u2013 Add and remove local groups", "ansible.windows.win_hostname module \u2013 Manages local Windows computer name", "ansible.windows.win_optional_feature module \u2013 Manage optional Windows features", "ansible.windows.win_owner module \u2013 Set owner", "ansible.windows.win_package module \u2013 Installs/uninstalls an installable package", "ansible.windows.win_path module \u2013 Manage Windows path environment variables", "ansible.windows.win_ping module \u2013 A windows version of the classic ping module", "ansible.windows.win_powershell module \u2013 Run PowerShell scripts", "ansible.windows.win_reboot module \u2013 Reboot a windows machine", "ansible.windows.win_reg_stat module \u2013 Get information about Windows registry keys", "ansible.windows.win_regedit module \u2013 Add, change, or remove registry keys and values", "ansible.windows.win_service_info module \u2013 Gather information about Windows services", "ansible.windows.win_service module \u2013 Manage and query Windows services", "ansible.windows.win_share module \u2013 Manage Windows shares", "ansible.windows.win_shell module \u2013 Execute shell commands on target hosts", "ansible.windows.win_stat module \u2013 Get information about Windows files", "ansible.windows.win_tempfile module \u2013 Creates temporary files and directories", "ansible.windows.win_template module \u2013 Template a file out to a remote server", "ansible.windows.win_updates module \u2013 Download and install Windows updates", "ansible.windows.win_uri module \u2013 Interacts with webservices", "ansible.windows.win_user module \u2013 Manages local Windows user accounts", "ansible.windows.win_user_right module \u2013 Manage Windows User Rights", "ansible.windows.win_wait_for module \u2013 Waits for a condition before continuing", "ansible.windows.win_whoami module \u2013 Get information about the current user and process", "Index of all Collection Environment Variables", "Collection Index", "Index of all Filter Plugins", "Index of all Modules", "Welcome to my Ansible collection documentation"], "titleterms": {"": 3, "A": 28, "about": [4, 31, 33, 37, 45], "account": 42, "acl": 6, "add": [22, 32], "all": [46, 48, 49], "also": [1, 3, 4, 5, 6, 7, 9, 10, 12, 13, 14, 16, 17, 18, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 36, 37, 38, 39, 40, 41, 42, 43, 44, 45], "an": 26, "ansibl": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44, 45, 48, 49, 50], "argument": 3, "async_statu": 1, "asynchron": 1, "attribut": 1, "author": [1, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44, 45], "base": 19, "befor": 44, "certif": [7, 8], "chang": [6, 32], "classic": 28, "collect": [0, 1, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44, 45, 46, 47, 50], "command": [9, 36], "commun": 2, "comput": 23, "condit": 44, "configur": [11, 15], "continu": 44, "control": 12, "copi": 10, "creat": [18, 38], "criteria": 19, "current": 45, "deprec": [12, 13, 14], "descript": 2, "directori": [7, 18, 38], "dn": 11, "document": 50, "domain": [12, 13, 14], "download": [20, 40], "dsc": 15, "ensur": 14, "environ": [16, 27, 46], "exampl": [1, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44, 45], "execut": [9, 36], "exist": 14, "fact": 4, "featur": [17, 24], "file": [5, 7, 10, 18, 19, 20, 37, 38, 39], "filter": [2, 3, 48], "from": [5, 20], "ftp": 20, "gather": [4, 33], "get": [31, 37, 45], "group": [7, 21, 22], "host": [4, 10, 11, 12, 13, 16, 36], "http": 20, "index": [2, 46, 47, 48, 49, 50], "inform": [31, 33, 37, 45], "inherit": 6, "input": 3, "instal": [17, 26, 40], "interact": 41, "invok": 15, "kei": [31, 32], "keyword": 3, "link": [1, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44, 45], "list": 19, "local": [21, 22, 23, 42], "locat": 10, "lookup": 11, "machin": 30, "manag": [8, 12, 13, 21, 23, 24, 27, 34, 35, 42, 43], "member": 12, "membership": [13, 21], "modifi": 16, "modul": [1, 2, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44, 45, 49], "my": 50, "name": 23, "namespac": 0, "node": [5, 9, 20], "note": [4, 5, 7, 8, 9, 10, 15, 16, 19, 20, 26, 27, 29, 30, 31, 32, 34, 36, 39, 40, 42, 43, 45], "obtain": 1, "option": 24, "out": 39, "owner": 25, "packag": 26, "paramet": [1, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44], "path": 27, "permiss": 7, "ping": 28, "plugin": [2, 48, 50], "powershel": [15, 29], "process": 45, "queri": 34, "quot": 3, "reboot": 30, "refer": 50, "registri": [7, 31, 32], "remot": [4, 5, 9, 10, 39], "remov": [18, 22, 32], "requir": 35, "return": [1, 3, 5, 8, 9, 10, 12, 13, 14, 15, 16, 17, 19, 20, 21, 23, 24, 26, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44, 45], "right": 43, "run": 29, "script": 29, "see": [1, 3, 4, 5, 6, 7, 9, 10, 12, 13, 14, 16, 17, 18, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 36, 37, 38, 39, 40, 41, 42, 43, 44, 45], "server": [12, 17, 39], "servic": [33, 34], "set": [7, 25], "setup": 4, "share": 35, "shell": [3, 36], "slurp": 5, "specif": 19, "state": 12, "statu": [1, 12, 13, 14], "store": 8, "synopsi": [1, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44, 45], "system": 7, "target": 36, "task": 1, "templat": 39, "temporari": 38, "touch": 18, "uninstal": [17, 26], "updat": 40, "user": [7, 42, 43, 45], "valu": [1, 3, 5, 8, 9, 10, 12, 13, 14, 15, 16, 17, 19, 20, 21, 23, 24, 26, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44, 45], "variabl": [16, 27, 46], "variou": 3, "version": 28, "wait": 44, "webservic": 41, "welcom": 50, "win_acl": 7, "win_acl_inherit": 6, "win_certificate_stor": 8, "win_command": 9, "win_copi": 10, "win_dns_client": 11, "win_domain": 14, "win_domain_control": 12, "win_domain_membership": 13, "win_dsc": 15, "win_environ": 16, "win_featur": 17, "win_fil": 18, "win_find": 19, "win_get_url": 20, "win_group": 22, "win_group_membership": 21, "win_hostnam": 23, "win_optional_featur": 24, "win_own": 25, "win_p": 28, "win_packag": 26, "win_path": 27, "win_powershel": 29, "win_reboot": 30, "win_reg_stat": 31, "win_regedit": 32, "win_servic": 34, "win_service_info": 33, "win_shar": 35, "win_shel": 36, "win_stat": 37, "win_tempfil": 38, "win_templ": 39, "win_upd": 40, "win_uri": 41, "win_us": 42, "win_user_right": 43, "win_wait_for": 44, "win_whoami": 45, "window": [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44, 45, 48, 49], "workgroup": 13}})
\ No newline at end of file
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+