This integration enables the management of Microsoft Windows hosts directly from XSOAR using Ansible modules. The Ansible engine is self-contained and pre-configured as part of this pack onto your XSOAR server, all you need to do is provide credentials you are ready to use the feature rich commands. This integration functions without any agents or additional software installed on the Windows hosts by utilising the Windows Remote Management (WinRM) API interface present in Windows 2008 and above combined with PowerShell.

To use this integration, configure an instance of this integration. This will associate a credential to be used to access hosts when commands are run. The commands from this integration will take the Windows host address(es) as an input, and use the saved credential associated to the instance to execute. Create separate instances if multiple credentials are required.

This integration uses NTLM for authentication. This ensures that actual credentials are never sent over the network, instead relying on hashing methods. By default, the initial authentication phase is performed unencrypted over HTTP, after which all communication is encrypted using a symmetric 256-bit key. If it is desired to use HTTPS from the onset, additional configuration on the Windows host is required. After WinRM is configured for HTTPS, update the port setting on the integration. Any port other than the default 5985 will use HTTPS communication.

Host Requirements

WinRM is enabled by default on all Windows Server operating systems since Windows Server 2012 and above, but disabled on all client operating systems like Windows 10, Windows 8 and Windows 7.

WinRM can be enabled on Windows client OSes using Group Policy.

PowerShell 3.0 or newer and at least .NET 4.0 to be installed on the Windows host.

Network Requirements

By default, TCP port 5985 will be used. If WinRM is configured for HTTPS, update the port setting on the integration.

Please also note that the default Windows Firewall Policy (Windows Remote Management (HTTP-In)) allows WinRM connections only from the private networks.

The connection will be initiated from the XSOAR engine/server specified in the instance settings.

Credentials

A Windows Domain Account is recommended; however local accounts are also supported.
The username syntax can be in Pre-Windows2000 style (domain.local/account) or in newer UPN format (account@domain.local)

Permissions

While Administrative privileges are not strictly required, WinRM is configured by default to only allow connections from accounts in the local Administrators group.

Non-administrative accounts can be used with WinRM, however most typical server administration tasks require some level of administrative access, so the utility is usually limited.

Concurrency

This integration supports execution of commands against multiple hosts concurrently. The host parameter accepts a list of addresses, and will run the command in parallel as per the Concurrency Factor value.

Further information

This integration is powered by Ansible 2.9. Further information can be found on that the following locations:

• Ansible Windows Guide
• Windows Module Index

Configure Ansible Microsoft Windows on Cortex XSOAR

1. Navigate to Settings > Integrations > Servers & Services.
2. Search for Ansible Microsoft Windows.

3. Click Add instance to create and configure a new integration instance.

   Parameter	Description	Required
   Username	The credentials to associate with the instance.	True
   Default WinRM Port	The default port to use if one is not specified in the commands `host` argument. If 5985 is specified the HTTP transport method will be used. Otherwise HTTPS will be used for all other ports	True
   Concurrency Factor	If multiple hosts are specified in a command, how many hosts should be interacted with concurrently.	True

Testing

This integration does not support testing from the integration management screen. Instead it is recommended to use the !win-gather-factscommand providing an example host as the command argument. This command will connect to the specified host with the configured credentials in the integration, and if successful output general information about the host.

Complex Command Inputs

Some commands may require structured input arguments such as lists or dictionary, these can be provided in standard JSON notation wrapped in double curly braces. For example a argument called dns_servers that accepts a list of server IPs 8.8.8.8 and 8.8.4.4 would be entered as dns_servers="{{ ['8.8.8.8', '8.8.4.4'] }}".

Other more advanced data manipulation tools such as Ansible/Jinja2 filters can also be used in-line. For example to get a random number between 0 and 60 you can use {{ 60 | random }}.

Commands

You can execute these commands from the Cortex XSOAR CLI, as part of an automation, or in a playbook.
After you successfully execute a command, a DBot message appears in the War Room with the command details.

win-gather-facts

Gathers facts about remote hosts
Further documentation available at https://docs.ansible.com/ansible/2.9/modules/gather_facts_module.html

Base Command

win-gather-facts

Input

Context Output

| Path | Type | Description |
| — | — | — |

win-acl

Set file/directory/registry permissions for a system user or group
Further documentation available at https://docs.ansible.com/ansible/2.9/modules/win_acl_module.html

Base Command

win-acl

Input

Context Output

| Path | Type | Description |
| — | — | — |

Command Example

!win-acl host="123.123.123.123" user="fed-phil" path="C:\\Important\\Executable.exe" type="deny" rights="ExecuteFile,Write"

Context Example

{
    "MicrosoftWindows": {
        "WinAcl": {
            "changed": true,
            "host": "123.123.123.123",
            "status": "CHANGED"
        }
    }
}

Human Readable Output

123.123.123.123 - CHANGED

• changed: True

win-acl-inheritance

Change ACL inheritance
Further documentation available at https://docs.ansible.com/ansible/2.9/modules/win_acl_inheritance_module.html

Base Command

win-acl-inheritance

Input

Context Output

| Path | Type | Description |
| — | — | — |

Command Example

!win-acl-inheritance host="123.123.123.123" path="C://apache" state="absent"

Context Example

{
    "MicrosoftWindows": {
        "WinAclInheritance": {
            "changed": true,
            "host": "123.123.123.123",
            "status": "CHANGED"
        }
    }
}

Human Readable Output

123.123.123.123 - CHANGED

• changed: True

win-audit-policy-system

Used to make changes to the system wide Audit Policy
Further documentation available at https://docs.ansible.com/ansible/2.9/modules/win_audit_policy_system_module.html

Base Command

win-audit-policy-system

Input

Context Output

Command Example

!win-audit-policy-system host="123.123.123.123" subcategory="File System" audit_type="failure"

Context Example

{
    "MicrosoftWindows": {
        "WinAuditPolicySystem": {
            "changed": false,
            "current_audit_policy": {
                "file system": "failure"
            },
            "host": "123.123.123.123",
            "status": "SUCCESS"
        }
    }
}

Human Readable Output

123.123.123.123 - SUCCESS

• changed: False

• Current_Audit_Policy

  • file system: failure

win-audit-rule

Adds an audit rule to files, folders, or registry keys
Further documentation available at https://docs.ansible.com/ansible/2.9/modules/win_audit_rule_module.html

Base Command

win-audit-rule

Input

Context Output

Command Example

!win-audit-rule host="123.123.123.123" path="C:\\inetpub\\wwwroot\\website" user="BUILTIN\\Users" rights="write,delete,changepermissions" audit_flags="success,failure" inheritance_flags="ContainerInherit,ObjectInherit"

Context Example

{
    "MicrosoftWindows": {
        "WinAuditRule": {
            "changed": true,
            "current_audit_rules": {
                "audit_flags": "Success, Failure",
                "inheritance_flags": "ContainerInherit, ObjectInherit",
                "is_inherited": "False",
                "propagation_flags": "None",
                "rights": "Write, Delete, ChangePermissions",
                "user": "BUILTIN\\Users"
            },
            "host": "123.123.123.123",
            "path_type": "directory",
            "status": "CHANGED"
        }
    }
}

Human Readable Output

123.123.123.123 - CHANGED

• changed: True

• path_type: directory

• Current_Audit_Rules

  • audit_flags: Success, Failure
  • inheritance_flags: ContainerInherit, ObjectInherit
  • is_inherited: False
  • propagation_flags: None
  • rights: Write, Delete, ChangePermissions
  • user: BUILTIN\Users

win-certificate-store

Manages the certificate store
Further documentation available at https://docs.ansible.com/ansible/2.9/modules/win_certificate_store_module.html

Base Command

win-certificate-store

Input

Context Output

Command Example

!win-certificate-store host="123.123.123.123" path="C:\\Temp\\cert.pem" state="present"

Context Example

{
    "MicrosoftWindows": {
        "WinCertificateStore": {
            "changed": true,
            "host": "123.123.123.123",
            "status": "CHANGED",
            "thumbprints": [
                "58288A1E834AD6E157688226A7206914CBD28519"
            ]
        }
    }
}

Human Readable Output

123.123.123.123 - CHANGED

• changed: True

• Thumbprints

  • 0: 58288A1E834AD6E157688226A7206914CBD28519

win-chocolatey

Manage packages using chocolatey
Further documentation available at https://docs.ansible.com/ansible/2.9/modules/win_chocolatey_module.html

Base Command

win-chocolatey

Input

Context Output

Command Example

!win-chocolatey host="123.123.123.123" name="git" state="present"

Context Example

{
    "MicrosoftWindows": {
        "WinChocolatey": {
            "changed": true,
            "host": "123.123.123.123",
            "rc": 0,
            "status": "CHANGED"
        }
    }
}

Human Readable Output

123.123.123.123 - CHANGED

• changed: True
• rc: 0

win-chocolatey-config

Manages Chocolatey config settings
Further documentation available at https://docs.ansible.com/ansible/2.9/modules/win_chocolatey_config_module.html

Base Command

win-chocolatey-config

Input

Context Output

| Path | Type | Description |
| — | — | — |

Command Example

!win-chocolatey-config host="123.123.123.123" name="cacheLocation" state="present" value="D:\\chocolatey_temp"

Context Example

{
    "MicrosoftWindows": {
        "WinChocolateyConfig": {
            "changed": true,
            "host": "123.123.123.123",
            "status": "CHANGED"
        }
    }
}

Human Readable Output

123.123.123.123 - CHANGED

• changed: True

win-chocolatey-facts

Create a facts collection for Chocolatey
Further documentation available at https://docs.ansible.com/ansible/2.9/modules/win_chocolatey_facts_module.html

Base Command

win-chocolatey-facts

Input

Context Output

Command Example

!win-chocolatey-facts host="123.123.123.123"

Context Example

{
    "MicrosoftWindows": {
        "WinChocolateyFacts": {
            "chocolatey": {
                "config": {
                    "cacheLocation": "D:\\chocolatey_temp",
                    "commandExecutionTimeoutSeconds": 2700,
                    "containsLegacyPackageInstalls": true,
                    "proxy": "",
                    "proxyBypassList": "",
                    "proxyBypassOnLocal": true,
                    "proxyPassword": "",
                    "proxyUser": "",
                    "upgradeAllExceptions": "",
                    "webRequestTimeoutSeconds": 30
                },
                "feature": {
                    "allowEmptyChecksums": false,
                    "allowEmptyChecksumsSecure": true,
                    "allowGlobalConfirmation": false,
                    "autoUninstaller": true,
                    "checksumFiles": true,
                    "exitOnRebootDetected": false,
                    "failOnAutoUninstaller": false,
                    "failOnInvalidOrMissingLicense": false,
                    "failOnStandardError": false,
                    "ignoreInvalidOptionsSwitches": true,
                    "ignoreUnfoundPackagesOnUpgradeOutdated": false,
                    "logEnvironmentValues": false,
                    "logValidationResultsOnWarnings": true,
                    "logWithoutColor": false,
                    "powershellHost": true,
                    "removePackageInformationOnUninstall": false,
                    "scriptsCheckLastExitCode": false,
                    "showDownloadProgress": true,
                    "showNonElevatedWarnings": true,
                    "skipPackageUpgradesWhenNotInstalled": false,
                    "stopOnFirstPackageFailure": false,
                    "useEnhancedExitCodes": false,
                    "useFipsCompliantChecksums": false,
                    "usePackageExitCodes": true,
                    "usePackageRepositoryOptimizations": true,
                    "useRememberedArgumentsForUpgrades": false,
                    "virusCheck": false
                },
                "packages": [
                    {
                        "package": "chocolatey",
                        "version": "0.10.15"
                    },
                    {
                        "package": "chocolatey-core.extension",
                        "version": "1.1.1.1"
                    },
                    {
                        "package": "git",
                        "version": "2.32.0"
                    },
                    {
                        "package": "git.install",
                        "version": "2.32.0"
                    },
                    {
                        "package": "nssm",
                        "version": "2.24.101.20180116"
                    }
                ],
                "sources": [
                    {
                        "admin_only": false,
                        "allow_self_service": false,
                        "bypass_proxy": false,
                        "certificate": null,
                        "disabled": false,
                        "name": "chocolatey",
                        "priority": 0,
                        "source": "https://chocolatey.org/api/v2/",
                        "source_username": null
                    }
                ]
            },
            "host": "123.123.123.123",
            "status": "SUCCESS"
        }
    }
}

Human Readable Output

123.123.123.123 - SUCCESS

• Chocolatey

  • Config

    • cacheLocation: D:\chocolatey_temp
    • commandExecutionTimeoutSeconds: 2700
    • containsLegacyPackageInstalls: True
    • proxy:
    • proxyBypassList:
    • proxyBypassOnLocal: True
    • proxyPassword:
    • proxyUser:
    • upgradeAllExceptions:
    • webRequestTimeoutSeconds: 30

  • Feature

    • allowEmptyChecksums: False
    • allowEmptyChecksumsSecure: True
    • allowGlobalConfirmation: False
    • autoUninstaller: True
    • checksumFiles: True
    • exitOnRebootDetected: False
    • failOnAutoUninstaller: False
    • failOnInvalidOrMissingLicense: False
    • failOnStandardError: False
    • ignoreInvalidOptionsSwitches: True
    • ignoreUnfoundPackagesOnUpgradeOutdated: False
    • logEnvironmentValues: False
    • logValidationResultsOnWarnings: True
    • logWithoutColor: False
    • powershellHost: True
    • removePackageInformationOnUninstall: False
    • scriptsCheckLastExitCode: False
    • showDownloadProgress: True
    • showNonElevatedWarnings: True
    • skipPackageUpgradesWhenNotInstalled: False
    • stopOnFirstPackageFailure: False
    • useEnhancedExitCodes: False
    • useFipsCompliantChecksums: False
    • usePackageExitCodes: True
    • usePackageRepositoryOptimizations: True
    • useRememberedArgumentsForUpgrades: False
    • virusCheck: False

  • Packages

  • List

    • package: chocolatey
    • version: 0.10.15

  • List

    • package: chocolatey-core.extension
    • version: 1.1.1.1

  • List

    • package: git
    • version: 2.32.0

  • List

    • package: git.install
    • version: 2.32.0

  • List

    • package: nssm
    • version: 2.24.101.20180116

  • Sources

  • Chocolatey

    • admin_only: False
    • allow_self_service: False
    • bypass_proxy: False
    • certificate: None
    • disabled: False
    • name: chocolatey
    • priority: 0
    • source: https://chocolatey.org/api/v2/
    • source_username: None

win-chocolatey-feature

Manages Chocolatey features
Further documentation available at https://docs.ansible.com/ansible/2.9/modules/win_chocolatey_feature_module.html

Base Command

win-chocolatey-feature

Input

Context Output

| Path | Type | Description |
| — | — | — |

Command Example

!win-chocolatey-feature host="123.123.123.123" name="checksumFiles" state="disabled"

Context Example

{
    "MicrosoftWindows": {
        "WinChocolateyFeature": {
            "changed": true,
            "host": "123.123.123.123",
            "status": "CHANGED"
        }
    }
}

Human Readable Output

123.123.123.123 - CHANGED

• changed: True

win-chocolatey-source

Manages Chocolatey sources
Further documentation available at https://docs.ansible.com/ansible/2.9/modules/win_chocolatey_source_module.html

Base Command

win-chocolatey-source

Input

Context Output

| Path | Type | Description |
| — | — | — |

Command Example

!win-chocolatey-source host="123.123.123.123" name="chocolatey" state="present"

Context Example

{
    "MicrosoftWindows": {
        "WinChocolateySource": {
            "changed": false,
            "host": "123.123.123.123",
            "status": "SUCCESS"
        }
    }
}

Human Readable Output

123.123.123.123 - SUCCESS

• changed: False

win-copy

Copies files to remote locations on windows hosts
Further documentation available at https://docs.ansible.com/ansible/2.9/modules/win_copy_module.html

Base Command

win-copy

Input

Context Output

Command Example

!win-copy host="123.123.123.123" "src"="C:\\Important\\Executable.exe" dest="C:\\Temp" remote_"src"=yes

Context Example

{
    "MicrosoftWindows": {
        "WinCopy": {
            "changed": true,
            "checksum": "4a2446ee9651d90ac6c5613bddf416df197f6401",
            "dest": "C:\\Temp\\Executable.exe",
            "host": "123.123.123.123",
            "operation": "file_copy",
            "original_basename": "Executable.exe",
            "size": 32256,
            "src": "C:\\Important\\Executable.exe",
            "status": "CHANGED"
        }
    }
}

Human Readable Output

123.123.123.123 - CHANGED

• changed: True
• checksum: 4a2446ee9651d90ac6c5613bddf416df197f6401
• dest: C:\Temp\Executable.exe
• operation: file_copy
• original_basename: Executable.exe
• size: 32256
• src: C:\Important\Executable.exe

win-credential

Manages Windows Credentials in the Credential Manager
Further documentation available at https://docs.ansible.com/ansible/2.9/modules/win_credential_module.html

Base Command

win-credential

Input

Context Output

| Path | Type | Description |
| — | — | — |

win-defrag

Consolidate fragmented files on local volumes
Further documentation available at https://docs.ansible.com/ansible/2.9/modules/win_defrag_module.html

Base Command

win-defrag

Input

Context Output

Command Example

!win-defrag host="123.123.123.123" parallel="True"

Context Example

{
    "MicrosoftWindows": {
        "WinDefrag": {
            "changed": true,
            "cmd": "defrag.exe /C /M /V",
            "delta": "0:00:00.062484",
            "end": "2021-06-29 03:14:21.017314",
            "host": "123.123.123.123",
            "rc": 0,
            "start": "2021-06-29 03:14:20.954829",
            "status": "CHANGED",
            "stderr": "",
            "stderr_lines": [],
            "stdout": "Microsoft Drive Optimizer\r\nCopyright (c) 2013 Microsoft Corp.\r\n\r\nAn invalid command line option was specified. (0x89000008)\r\n\r\nDescription:\r\n\r\n\tOptimizes and defragments files on local volumes to\r\n\timprove system performance.\r\n\r\nSyntax:\r\n\r\n\tdefrag  | /C | /E  [<task(s)>] [/H] [/M [n] | [/U] [/V]] [/I n]\r\n\r\n\tWhere <task(s)> is omitted (traditional defrag), or as follows:\r\n\t\t/A | [/D] [/K] [/L] | /O | /X\r\n\r\n\tOr, to track an operation already in progress on a volume:\r\n\tdefrag  /T\r\n\r\nParameters:\r\n\r\n\tValue\tDescription\r\n\r\n\t/A\tPerform analysis on the specified volumes.\r\n\r\n\t/C\tPerform the operation on all volumes.\r\n\r\n\t/D\tPerform traditional defrag (this is the default).\r\n\r\n\t/E\tPerform the operation on all volumes except those specified.\r\n\r\n\t/G\tOptimize the storage tiers on the specified volumes.\r\n\r\n\t/H\tRun the operation at normal priority (default is low).\r\n\r\n\t/I n\tTier optimization would run for at most n seconds on each volume.\r\n\r\n\t/K\tPerform slab consolidation on the specified volumes.\r\n\r\n\t/L\tPerform retrim on the specified volumes.\r\n\r\n\t/M [n]\tRun the operation on each volume in parallel in the background.\r\n\t\tAt most n threads optimize the storage tiers in parallel.\r\n\r\n\t/O\tPerform the proper optimization for each media type.\r\n\r\n\t/T\tTrack an operation already in progress on the specified volume.\r\n\r\n\t/U\tPrint the progress of the operation on the screen.\r\n\r\n\t/V\tPrint verbose output containing the fragmentation statistics.\r\n\r\n\t/X\tPerform free space consolidation on the specified volumes.\r\n\r\nExamples:\r\n\r\n\tdefrag C: /U /V\r\n\tdefrag C: D: /M\r\n\tdefrag C:\\mountpoint /A /U\r\n\tdefrag /C /H /V\r\n",
            "stdout_lines": [
                "Microsoft Drive Optimizer",
                "Copyright (c) 2013 Microsoft Corp.",
                "",
                "An invalid command line option was specified. (0x89000008)",
                "",
                "Description:",
                "",
                "\tOptimizes and defragments files on local volumes to",
                "\timprove system performance.",
                "",
                "Syntax:",
                "",
                "\tdefrag | /C | /E  [<task(s)>] [/H] [/M [n] | [/U] [/V]] [/I n]",
                "",
                "\tWhere <task(s)> is omitted (traditional defrag), or as follows:",
                "\t\t/A | [/D] [/K] [/L] | /O | /X",
                "",
                "\tOr, to track an operation already in progress on a volume:",
                "\tdefrag  /T",
                "",
                "Parameters:",
                "",
                "\tValue\tDescription",
                "",
                "\t/A\tPerform analysis on the specified volumes.",
                "",
                "\t/C\tPerform the operation on all volumes.",
                "",
                "\t/D\tPerform traditional defrag (this is the default).",
                "",
                "\t/E\tPerform the operation on all volumes except those specified.",
                "",
                "\t/G\tOptimize the storage tiers on the specified volumes.",
                "",
                "\t/H\tRun the operation at normal priority (default is low).",
                "",
                "\t/I n\tTier optimization would run for at most n seconds on each volume.",
                "",
                "\t/K\tPerform slab consolidation on the specified volumes.",
                "",
                "\t/L\tPerform retrim on the specified volumes.",
                "",
                "\t/M [n]\tRun the operation on each volume in parallel in the background.",
                "\t\tAt most n threads optimize the storage tiers in parallel.",
                "",
                "\t/O\tPerform the proper optimization for each media type.",
                "",
                "\t/T\tTrack an operation already in progress on the specified volume.",
                "",
                "\t/U\tPrint the progress of the operation on the screen.",
                "",
                "\t/V\tPrint verbose output containing the fragmentation statistics.",
                "",
                "\t/X\tPerform free space consolidation on the specified volumes.",
                "",
                "Examples:",
                "",
                "\tdefrag C: /U /V",
                "\tdefrag C: D: /M",
                "\tdefrag C:\\mountpoint /A /U",
                "\tdefrag /C /H /V"
            ]
        }
    }
}

Human Readable Output

123.123.123.123 - CHANGED

• changed: True
• cmd: defrag.exe /C /M /V
• delta: 0:00:00.062484
• end: 2021-06-29 03:14:21.017314
• rc: 0
• start: 2021-06-29 03:14:20.954829
• stderr:
• stdout: Microsoft Drive Optimizer
  Copyright (c) 2013 Microsoft Corp.

An invalid command line option was specified. (0x89000008)

Description:

timizes and defragments files on local volumes to
prove system performance.

Syntax:

frag

/C

/E [<task(s)>] [/H] [/M [n]

[/U] [/V]] [/I n]

ere <task(s)> is omitted (traditional defrag), or as follows:
[/D] [/K] [/L] | /O | /X

, to track an operation already in progress on a volume:
frag /T

Parameters:

lue Description

Perform analysis on the specified volumes.

Perform the operation on all volumes.

Perform traditional defrag (this is the default).

Perform the operation on all volumes except those specified.

Optimize the storage tiers on the specified volumes.

Run the operation at normal priority (default is low).

n Tier optimization would run for at most n seconds on each volume.

Perform slab consolidation on the specified volumes.

Perform retrim on the specified volumes.

[n] Run the operation on each volume in parallel in the background.
st n threads optimize the storage tiers in parallel.

Perform the proper optimization for each media type.

Track an operation already in progress on the specified volume.

Print the progress of the operation on the screen.

Print verbose output containing the fragmentation statistics.

Perform free space consolidation on the specified volumes.

Examples:

frag C: /U /V
frag C: D: /M
frag C:\mountpoint /A /U
frag /C /H /V

• Stderr_Lines

• Stdout_Lines

  • 0: Microsoft Drive Optimizer
  • 1: Copyright (c) 2013 Microsoft Corp.
  • 2:
  • 3: An invalid command line option was specified. (0x89000008)
  • 2:
  • 5: Description:
  • 2:
  • 7: Optimizes and defragments files on local volumes to
  • 8: improve system performance.
  • 2:
  • 10: Syntax:
  • 2:

  • 12: defrag

    /C

    /E [<task(s)>] [/H] [/M [n]

    [/U] [/V]] [/I n]

  • 2:
  • 14: Where <task(s)> is omitted (traditional defrag), or as follows:

  • 15: /A

    [/D] [/K] [/L]

    /O

    /X

  • 2:
  • 17: Or, to track an operation already in progress on a volume:
  • 18: defrag /T
  • 2:
  • 20: Parameters:
  • 2:
  • 22: Value Description
  • 2:
  • 24: /A Perform analysis on the specified volumes.
  • 2:
  • 26: /C Perform the operation on all volumes.
  • 2:
  • 28: /D Perform traditional defrag (this is the default).
  • 2:
  • 30: /E Perform the operation on all volumes except those specified.
  • 2:
  • 32: /G Optimize the storage tiers on the specified volumes.
  • 2:
  • 34: /H Run the operation at normal priority (default is low).
  • 2:
  • 36: /I n Tier optimization would run for at most n seconds on each volume.
  • 2:
  • 38: /K Perform slab consolidation on the specified volumes.
  • 2:
  • 40: /L Perform retrim on the specified volumes.
  • 2:
  • 42: /M [n] Run the operation on each volume in parallel in the background.
  • 43: At most n threads optimize the storage tiers in parallel.
  • 2:
  • 45: /O Perform the proper optimization for each media type.
  • 2:
  • 47: /T Track an operation already in progress on the specified volume.
  • 2:
  • 49: /U Print the progress of the operation on the screen.
  • 2:
  • 51: /V Print verbose output containing the fragmentation statistics.
  • 2:
  • 53: /X Perform free space consolidation on the specified volumes.
  • 2:
  • 55: Examples:
  • 2:
  • 57: defrag C: /U /V
  • 58: defrag C: D: /M
  • 59: defrag C:\mountpoint /A /U
  • 60: defrag /C /H /V

win-disk-facts

Show the attached disks and disk information of the target host
Further documentation available at https://docs.ansible.com/ansible/2.9/modules/win_disk_facts_module.html

Base Command

win-disk-facts

Input

Context Output

Command Example

!win-disk-facts host="123.123.123.123"

Context Example

{
    "MicrosoftWindows": {
        "WinDiskFacts": {
            "disks": [
                {
                    "bootable": true,
                    "bus_type": "SAS",
                    "clustered": false,
                    "firmware_version": "2.0 ",
                    "friendly_name": "VMware Virtual disk",
                    "guid": null,
                    "location": "SCSI0",
                    "manufacturer": "VMware  ",
                    "model": "Virtual disk    ",
                    "number": 0,
                    "operational_status": "Online",
                    "partition_count": 2,
                    "partition_style": "MBR",
                    "partitions": [
                        {
                            "access_paths": [
                                "\\\\?\\Volume{da4b1e8a-0000-0000-0000-100000000000}\\"
                            ],
                            "active": true,
                            "drive_letter": null,
                            "guid": null,
                            "hidden": false,
                            "mbr_type": 7,
                            "number": 1,
                            "offset": 1048576,
                            "shadow_copy": false,
                            "size": 524288000,
                            "transition_state": 1,
                            "type": "IFS",
                            "volumes": [
                                {
                                    "allocation_unit_size": 4096,
                                    "drive_type": "Fixed",
                                    "health_status": "Healthy",
                                    "label": "System Reserved",
                                    "object_id": "{1}\\\\WIN-U425UI0HPP7\\root/Microsoft/Windows/Storage/Providers_v2\\WSP_Volume.ObjectId=\"{65f97678-bd69-11eb-88d8-806e6f6e6963}:VO:\\\\?\\Volume{da4b1e8a-0000-0000-0000-100000000000}\\\"",
                                    "path": "\\\\?\\Volume{da4b1e8a-0000-0000-0000-100000000000}\\",
                                    "size": 524283904,
                                    "size_remaining": 179843072,
                                    "type": "NTFS"
                                }
                            ]
                        },
                        {
                            "access_paths": [
                                "C:\\",
                                "\\\\?\\Volume{da4b1e8a-0000-0000-0000-501f00000000}\\"
                            ],
                            "active": false,
                            "drive_letter": "C",
                            "guid": null,
                            "hidden": false,
                            "mbr_type": 7,
                            "number": 2,
                            "offset": 525336576,
                            "shadow_copy": false,
                            "size": 15579742208,
                            "transition_state": 1,
                            "type": "IFS",
                            "volumes": [
                                {
                                    "allocation_unit_size": 4096,
                                    "drive_type": "Fixed",
                                    "health_status": "Healthy",
                                    "label": "",
                                    "object_id": "{1}\\\\WIN-U425UI0HPP7\\root/Microsoft/Windows/Storage/Providers_v2\\WSP_Volume.ObjectId=\"{65f97678-bd69-11eb-88d8-806e6f6e6963}:VO:\\\\?\\Volume{da4b1e8a-0000-0000-0000-501f00000000}\\\"",
                                    "path": "\\\\?\\Volume{da4b1e8a-0000-0000-0000-501f00000000}\\",
                                    "size": 15579738112,
                                    "size_remaining": 1943584768,
                                    "type": "NTFS"
                                }
                            ]
                        }
                    ],
                    "path": "\\\\?\\scsi#disk&ven_vmware&prod_virtual_disk#5&1ec51bf7&0&000000#{53f56307-b6bf-11d0-94f2-00a0c91efb8b}",
                    "physical_disk": {
                        "allocated_size": 16106127360,
                        "bus_type": "SAS",
                        "can_pool": false,
                        "cannot_pool_reason": "Insufficient Capacity",
                        "device_id": "0",
                        "firmware_version": "2.0",
                        "friendly_name": "VMware Virtual disk",
                        "health_status": "Healthy",
                        "indication_enabled": null,
                        "manufacturer": "VMware",
                        "media_type": "SSD",
                        "model": "Virtual disk",
                        "object_id": "{1}\\\\WIN-U425UI0HPP7\\root/Microsoft/Windows/Storage/Providers_v2\\SPACES_PhysicalDisk.ObjectId=\"{65f97678-bd69-11eb-88d8-806e6f6e6963}:PD:{2ab9f649-d867-11eb-88db-806e6f6e6963}\"",
                        "operational_status": "OK",
                        "partial": true,
                        "physical_location": "SCSI0",
                        "serial_number": null,
                        "size": 16106127360,
                        "spindle_speed": 0,
                        "supported_usages": {
                            "Count": 5,
                            "value": [
                                "Auto-Select",
                                "Manual-Select",
                                "Hot Spare",
                                "Retired",
                                "Journal"
                            ]
                        },
                        "unique_id": "{2ab9f649-d867-11eb-88db-806e6f6e6963}",
                        "usage_type": "Auto-Select"
                    },
                    "read_only": false,
                    "sector_size": 512,
                    "serial_number": null,
                    "size": 16106127360,
                    "system_disk": true,
                    "unique_id": "SCSI\\DISK&VEN_VMWARE&PROD_VIRTUAL_DISK\\5&1EC51BF7&0&000000:WIN-U425UI0HPP7",
                    "win32_disk_drive": {
                        "availability": null,
                        "bytes_per_sector": 512,
                        "capabilities": [
                            3,
                            4
                        ],
                        "capability_descriptions": [
                            "Random Access",
                            "Supports Writing"
                        ],
                        "caption": "VMware Virtual disk SCSI Disk Device",
                        "compression_method": null,
                        "config_manager_error_code": 0,
                        "config_manager_user_config": false,
                        "creation_class_name": "Win32_DiskDrive",
                        "default_block_size": null,
                        "description": "Disk drive",
                        "device_id": "\\\\.\\PHYSICALDRIVE0",
                        "error_cleared": null,
                        "error_description": null,
                        "error_methodology": null,
                        "firmware_revision": "2.0 ",
                        "index": 0,
                        "install_date": null,
                        "interface_type": "SCSI",
                        "last_error_code": null,
                        "manufacturer": "(Standard disk drives)",
                        "max_block_size": null,
                        "max_media_size": null,
                        "media_loaded": true,
                        "media_type": "Fixed hard disk media",
                        "min_block_size": null,
                        "model": "VMware Virtual disk SCSI Disk Device",
                        "name": "\\\\.\\PHYSICALDRIVE0",
                        "needs_cleaning": null,
                        "number_of_media_supported": null,
                        "partitions": 4,
                        "pnp_device_id": "SCSI\\DISK&VEN_VMWARE&PROD_VIRTUAL_DISK\\5&1EC51BF7&0&000000",
                        "power_management_capabilities": null,
                        "power_management_supported": null,
                        "scsi_bus": 0,
                        "scsi_logical_unit": 0,
                        "scsi_port": 0,
                        "scsi_target_id": 0,
                        "sectors_per_track": 63,
                        "serial_number": null,
                        "signature": 3662356106,
                        "size": 16105098240,
                        "status": "OK",
                        "status_info": null,
                        "system_creation_class_name": "Win32_ComputerSystem",
                        "system_name": "WIN-U425UI0HPP7",
                        "total_cylinders": 1958,
                        "total_heads": 255,
                        "total_sectors": 31455270,
                        "total_tracks": 499290,
                        "tracks_per_cylinder": 255
                    }
                },
                {
                    "bootable": false,
                    "bus_type": "SAS",
                    "clustered": false,
                    "firmware_version": "2.0 ",
                    "friendly_name": "VMware Virtual disk",
                    "guid": null,
                    "location": "SCSI0",
                    "manufacturer": "VMware  ",
                    "model": "Virtual disk    ",
                    "number": 1,
                    "operational_status": "Online",
                    "partition_count": 1,
                    "partition_style": "MBR",
                    "partitions": [
                        {
                            "access_paths": [
                                "F:\\",
                                "\\\\?\\Volume{75516713-0000-0000-0000-010000000000}\\"
                            ],
                            "active": false,
                            "drive_letter": "F",
                            "guid": null,
                            "hidden": false,
                            "mbr_type": 7,
                            "number": 1,
                            "offset": 65536,
                            "shadow_copy": false,
                            "size": 16777216,
                            "transition_state": 1,
                            "type": "IFS",
                            "volumes": [
                                {
                                    "allocation_unit_size": 4096,
                                    "drive_type": "Fixed",
                                    "health_status": "Healthy",
                                    "label": "New Volume",
                                    "object_id": "{1}\\\\WIN-U425UI0HPP7\\root/Microsoft/Windows/Storage/Providers_v2\\WSP_Volume.ObjectId=\"{65f97678-bd69-11eb-88d8-806e6f6e6963}:VO:\\\\?\\Volume{75516713-0000-0000-0000-010000000000}\\\"",
                                    "path": "\\\\?\\Volume{75516713-0000-0000-0000-010000000000}\\",
                                    "size": 16773120,
                                    "size_remaining": 6569984,
                                    "type": "NTFS"
                                }
                            ]
                        }
                    ],
                    "path": "\\\\?\\scsi#disk&ven_vmware&prod_virtual_disk#5&1ec51bf7&0&000100#{53f56307-b6bf-11d0-94f2-00a0c91efb8b}",
                    "physical_disk": {
                        "allocated_size": 2097152,
                        "bus_type": "SAS",
                        "can_pool": false,
                        "cannot_pool_reason": "Insufficient Capacity",
                        "device_id": "1",
                        "firmware_version": "2.0",
                        "friendly_name": "VMware Virtual disk",
                        "health_status": "Healthy",
                        "indication_enabled": null,
                        "manufacturer": "VMware",
                        "media_type": "SSD",
                        "model": "Virtual disk",
                        "object_id": "{1}\\\\WIN-U425UI0HPP7\\root/Microsoft/Windows/Storage/Providers_v2\\SPACES_PhysicalDisk.ObjectId=\"{65f97678-bd69-11eb-88d8-806e6f6e6963}:PD:{2aba10d3-d867-11eb-88db-000c29740042}\"",
                        "operational_status": "OK",
                        "partial": false,
                        "physical_location": "SCSI0",
                        "serial_number": null,
                        "size": 19922944,
                        "spindle_speed": 0,
                        "supported_usages": {
                            "Count": 5,
                            "value": [
                                "Auto-Select",
                                "Manual-Select",
                                "Hot Spare",
                                "Retired",
                                "Journal"
                            ]
                        },
                        "unique_id": "{2aba10d3-d867-11eb-88db-000c29740042}",
                        "usage_type": "Auto-Select"
                    },
                    "read_only": false,
                    "sector_size": 512,
                    "serial_number": null,
                    "size": 19922944,
                    "system_disk": false,
                    "unique_id": "SCSI\\DISK&VEN_VMWARE&PROD_VIRTUAL_DISK\\5&1EC51BF7&0&000100:WIN-U425UI0HPP7",
                    "win32_disk_drive": {
                        "availability": null,
                        "bytes_per_sector": 512,
                        "capabilities": [
                            3,
                            4
                        ],
                        "capability_descriptions": [
                            "Random Access",
                            "Supports Writing"
                        ],
                        "caption": "VMware Virtual disk SCSI Disk Device",
                        "compression_method": null,
                        "config_manager_error_code": 0,
                        "config_manager_user_config": false,
                        "creation_class_name": "Win32_DiskDrive",
                        "default_block_size": null,
                        "description": "Disk drive",
                        "device_id": "\\\\.\\PHYSICALDRIVE1",
                        "error_cleared": null,
                        "error_description": null,
                        "error_methodology": null,
                        "firmware_revision": "2.0 ",
                        "index": 1,
                        "install_date": null,
                        "interface_type": "SCSI",
                        "last_error_code": null,
                        "manufacturer": "(Standard disk drives)",
                        "max_block_size": null,
                        "max_media_size": null,
                        "media_loaded": true,
                        "media_type": "Fixed hard disk media",
                        "min_block_size": null,
                        "model": "VMware Virtual disk SCSI Disk Device",
                        "name": "\\\\.\\PHYSICALDRIVE1",
                        "needs_cleaning": null,
                        "number_of_media_supported": null,
                        "partitions": 4,
                        "pnp_device_id": "SCSI\\DISK&VEN_VMWARE&PROD_VIRTUAL_DISK\\5&1EC51BF7&0&000100",
                        "power_management_capabilities": null,
                        "power_management_supported": null,
                        "scsi_bus": 0,
                        "scsi_logical_unit": 0,
                        "scsi_port": 0,
                        "scsi_target_id": 1,
                        "sectors_per_track": 63,
                        "serial_number": null,
                        "signature": 1968269075,
                        "size": 16450560,
                        "status": "OK",
                        "status_info": null,
                        "system_creation_class_name": "Win32_ComputerSystem",
                        "system_name": "WIN-U425UI0HPP7",
                        "total_cylinders": 2,
                        "total_heads": 255,
                        "total_sectors": 32130,
                        "total_tracks": 510,
                        "tracks_per_cylinder": 255
                    }
                }
            ],
            "host": "123.123.123.123",
            "status": "SUCCESS"
        }
    }
}

Human Readable Output

123.123.123.123 - SUCCESS

• Disks

• Vmware Virtual Disk

  • bootable: True
  • bus_type: SAS
  • clustered: False
  • firmware_version: 2.0
  • friendly_name: VMware Virtual disk
  • guid: None
  • location: SCSI0
  • manufacturer: VMware
  • model: Virtual disk
  • number: 0
  • operational_status: Online
  • partition_count: 2
  • partition_style: MBR
  • path: \?\scsi#disk&ven_vmware&prod_virtual_disk#5&1ec51bf7&0&000000#{53f56307-b6bf-11d0-94f2-00a0c91efb8b}
  • read_only: False
  • sector_size: 512
  • serial_number: None
  • size: 16106127360
  • system_disk: True

  • unique_id: SCSI\DISK&VEN_VMWARE&PROD_VIRTUAL_DISK\5&1EC51BF7&0&000000:WIN-U425UI0HPP7

  • Partitions

  • List

    • active: True
    • drive_letter: None
    • guid: None
    • hidden: False
    • mbr_type: 7
    • number: 1
    • offset: 1048576
    • shadow_copy: False
    • size: 524288000
    • transition_state: 1

    • type: IFS

    • Access_Paths

      • 0: \?\Volume{da4b1e8a-0000-0000-0000-100000000000}\

    • Volumes

    • {1}\Win-U425Ui0Hpp7\Root/Microsoft/Windows/Storage/Providers_V2\Wsp_Volume.Objectid=”{65F97678-Bd69-11Eb-88D8-806E6F6E6963}:Vo:\?\Volume{Da4B1E8A-0000-0000-0000-100000000000}"

      • allocation_unit_size: 4096
      • drive_type: Fixed
      • health_status: Healthy
      • label: System Reserved
      • object_id: {1}\WIN-U425UI0HPP7\root/Microsoft/Windows/Storage/Providers_v2\WSP_Volume.ObjectId=”{65f97678-bd69-11eb-88d8-806e6f6e6963}:VO:\?\Volume{da4b1e8a-0000-0000-0000-100000000000}"
      • path: \?\Volume{da4b1e8a-0000-0000-0000-100000000000}\
      • size: 524283904
      • size_remaining: 179843072
      • type: NTFS

  • List

    • active: False
    • drive_letter: C
    • guid: None
    • hidden: False
    • mbr_type: 7
    • number: 2
    • offset: 525336576
    • shadow_copy: False
    • size: 15579742208
    • transition_state: 1

    • type: IFS

    • Access_Paths

      • 0: C:\
      • 1: \?\Volume{da4b1e8a-0000-0000-0000-501f00000000}\

    • Volumes

    • {1}\Win-U425Ui0Hpp7\Root/Microsoft/Windows/Storage/Providers_V2\Wsp_Volume.Objectid=”{65F97678-Bd69-11Eb-88D8-806E6F6E6963}:Vo:\?\Volume{Da4B1E8A-0000-0000-0000-501F00000000}"

      • allocation_unit_size: 4096
      • drive_type: Fixed
      • health_status: Healthy
      • label:
      • object_id: {1}\WIN-U425UI0HPP7\root/Microsoft/Windows/Storage/Providers_v2\WSP_Volume.ObjectId=”{65f97678-bd69-11eb-88d8-806e6f6e6963}:VO:\?\Volume{da4b1e8a-0000-0000-0000-501f00000000}"
      • path: \?\Volume{da4b1e8a-0000-0000-0000-501f00000000}\
      • size: 15579738112
      • size_remaining: 1943584768
      • type: NTFS

  • Physical_Disk

    • allocated_size: 16106127360
    • bus_type: SAS
    • can_pool: False
    • cannot_pool_reason: Insufficient Capacity
    • device_id: 0
    • firmware_version: 2.0
    • friendly_name: VMware Virtual disk
    • health_status: Healthy
    • indication_enabled: None
    • manufacturer: VMware
    • media_type: SSD
    • model: Virtual disk
    • object_id: {1}\WIN-U425UI0HPP7\root/Microsoft/Windows/Storage/Providers_v2\SPACES_PhysicalDisk.ObjectId=”{65f97678-bd69-11eb-88d8-806e6f6e6963}:PD:{2ab9f649-d867-11eb-88db-806e6f6e6963}”
    • operational_status: OK
    • partial: True
    • physical_location: SCSI0
    • serial_number: None
    • size: 16106127360
    • spindle_speed: 0
    • unique_id: {2ab9f649-d867-11eb-88db-806e6f6e6963}

    • usage_type: Auto-Select

    • Supported_Usages

      • Count: 5

      • Value

        • 0: Auto-Select
        • 1: Manual-Select
        • 2: Hot Spare
        • 3: Retired
        • 4: Journal

  • Win32_Disk_Drive

    • availability: None
    • bytes_per_sector: 512
    • caption: VMware Virtual disk SCSI Disk Device
    • compression_method: None
    • config_manager_error_code: 0
    • config_manager_user_config: False
    • creation_class_name: Win32_DiskDrive
    • default_block_size: None
    • description: Disk drive
    • device_id: \.\PHYSICALDRIVE0
    • error_cleared: None
    • error_description: None
    • error_methodology: None
    • firmware_revision: 2.0
    • index: 0
    • install_date: None
    • interface_type: SCSI
    • last_error_code: None
    • manufacturer: (Standard disk drives)
    • max_block_size: None
    • max_media_size: None
    • media_loaded: True
    • media_type: Fixed hard disk media
    • min_block_size: None
    • model: VMware Virtual disk SCSI Disk Device
    • name: \.\PHYSICALDRIVE0
    • needs_cleaning: None
    • number_of_media_supported: None
    • partitions: 4
    • pnp_device_id: SCSI\DISK&VEN_VMWARE&PROD_VIRTUAL_DISK\5&1EC51BF7&0&000000
    • power_management_capabilities: None
    • power_management_supported: None
    • scsi_bus: 0
    • scsi_logical_unit: 0
    • scsi_port: 0
    • scsi_target_id: 0
    • sectors_per_track: 63
    • serial_number: None
    • signature: 3662356106
    • size: 16105098240
    • status: OK
    • status_info: None
    • system_creation_class_name: Win32_ComputerSystem
    • system_name: WIN-U425UI0HPP7
    • total_cylinders: 1958
    • total_heads: 255
    • total_sectors: 31455270
    • total_tracks: 499290

    • tracks_per_cylinder: 255

    • Capabilities

      • 0: 3
      • 1: 4

    • Capability_Descriptions

      • 0: Random Access
      • 1: Supports Writing

• Vmware Virtual Disk

  • bootable: False
  • bus_type: SAS
  • clustered: False
  • firmware_version: 2.0
  • friendly_name: VMware Virtual disk
  • guid: None
  • location: SCSI0
  • manufacturer: VMware
  • model: Virtual disk
  • number: 1
  • operational_status: Online
  • partition_count: 1
  • partition_style: MBR
  • path: \?\scsi#disk&ven_vmware&prod_virtual_disk#5&1ec51bf7&0&000100#{53f56307-b6bf-11d0-94f2-00a0c91efb8b}
  • read_only: False
  • sector_size: 512
  • serial_number: None
  • size: 19922944
  • system_disk: False

  • unique_id: SCSI\DISK&VEN_VMWARE&PROD_VIRTUAL_DISK\5&1EC51BF7&0&000100:WIN-U425UI0HPP7

  • Partitions

  • List

    • active: False
    • drive_letter: F
    • guid: None
    • hidden: False
    • mbr_type: 7
    • number: 1
    • offset: 65536
    • shadow_copy: False
    • size: 16777216
    • transition_state: 1

    • type: IFS

    • Access_Paths

      • 0: F:\
      • 1: \?\Volume{75516713-0000-0000-0000-010000000000}\

    • Volumes

    • {1}\Win-U425Ui0Hpp7\Root/Microsoft/Windows/Storage/Providers_V2\Wsp_Volume.Objectid=”{65F97678-Bd69-11Eb-88D8-806E6F6E6963}:Vo:\?\Volume{75516713-0000-0000-0000-010000000000}"

      • allocation_unit_size: 4096
      • drive_type: Fixed
      • health_status: Healthy
      • label: New Volume
      • object_id: {1}\WIN-U425UI0HPP7\root/Microsoft/Windows/Storage/Providers_v2\WSP_Volume.ObjectId=”{65f97678-bd69-11eb-88d8-806e6f6e6963}:VO:\?\Volume{75516713-0000-0000-0000-010000000000}"
      • path: \?\Volume{75516713-0000-0000-0000-010000000000}\
      • size: 16773120
      • size_remaining: 6569984
      • type: NTFS

  • Physical_Disk

    • allocated_size: 2097152
    • bus_type: SAS
    • can_pool: False
    • cannot_pool_reason: Insufficient Capacity
    • device_id: 1
    • firmware_version: 2.0
    • friendly_name: VMware Virtual disk
    • health_status: Healthy
    • indication_enabled: None
    • manufacturer: VMware
    • media_type: SSD
    • model: Virtual disk
    • object_id: {1}\WIN-U425UI0HPP7\root/Microsoft/Windows/Storage/Providers_v2\SPACES_PhysicalDisk.ObjectId=”{65f97678-bd69-11eb-88d8-806e6f6e6963}:PD:{2aba10d3-d867-11eb-88db-000c29740042}”
    • operational_status: OK
    • partial: False
    • physical_location: SCSI0
    • serial_number: None
    • size: 19922944
    • spindle_speed: 0
    • unique_id: {2aba10d3-d867-11eb-88db-000c29740042}

    • usage_type: Auto-Select

    • Supported_Usages

      • Count: 5

      • Value

        • 0: Auto-Select
        • 1: Manual-Select
        • 2: Hot Spare
        • 3: Retired
        • 4: Journal

  • Win32_Disk_Drive

    • availability: None
    • bytes_per_sector: 512
    • caption: VMware Virtual disk SCSI Disk Device
    • compression_method: None
    • config_manager_error_code: 0
    • config_manager_user_config: False
    • creation_class_name: Win32_DiskDrive
    • default_block_size: None
    • description: Disk drive
    • device_id: \.\PHYSICALDRIVE1
    • error_cleared: None
    • error_description: None
    • error_methodology: None
    • firmware_revision: 2.0
    • index: 1
    • install_date: None
    • interface_type: SCSI
    • last_error_code: None
    • manufacturer: (Standard disk drives)
    • max_block_size: None
    • max_media_size: None
    • media_loaded: True
    • media_type: Fixed hard disk media
    • min_block_size: None
    • model: VMware Virtual disk SCSI Disk Device
    • name: \.\PHYSICALDRIVE1
    • needs_cleaning: None
    • number_of_media_supported: None
    • partitions: 4
    • pnp_device_id: SCSI\DISK&VEN_VMWARE&PROD_VIRTUAL_DISK\5&1EC51BF7&0&000100
    • power_management_capabilities: None
    • power_management_supported: None
    • scsi_bus: 0
    • scsi_logical_unit: 0
    • scsi_port: 0
    • scsi_target_id: 1
    • sectors_per_track: 63
    • serial_number: None
    • signature: 1968269075
    • size: 16450560
    • status: OK
    • status_info: None
    • system_creation_class_name: Win32_ComputerSystem
    • system_name: WIN-U425UI0HPP7
    • total_cylinders: 2
    • total_heads: 255
    • total_sectors: 32130
    • total_tracks: 510

    • tracks_per_cylinder: 255

    • Capabilities

      • 0: 3
      • 1: 4

    • Capability_Descriptions

      • 0: Random Access
      • 1: Supports Writing

win-disk-image

Manage ISO/VHD/VHDX mounts on Windows hosts
Further documentation available at https://docs.ansible.com/ansible/2.9/modules/win_disk_image_module.html

Base Command

win-disk-image

Input

Context Output

Command Example

!win-disk-image host="123.123.123.123" image_path="C:/install.iso" state="present"

Context Example

{
    "MicrosoftWindows": {
        "WinDiskImage": {
            "changed": true,
            "host": "123.123.123.123",
            "mount_paths": [
                "D:\\"
            ],
            "status": "CHANGED"
        }
    }
}

Human Readable Output

123.123.123.123 - CHANGED

• changed: True

• Mount_Paths

  • 0: D:\

win-dns-client

Configures DNS lookup on Windows hosts
Further documentation available at https://docs.ansible.com/ansible/2.9/modules/win_dns_client_module.html

Base Command

win-dns-client

Input

Context Output

| Path | Type | Description |
| — | — | — |

win-dns-record

Manage Windows Server DNS records
Further documentation available at https://docs.ansible.com/ansible/2.9/modules/win_dns_record_module.html

Base Command

win-dns-record

Input

Context Output

| Path | Type | Description |
| — | — | — |

win-domain

Ensures the existence of a Windows domain
Further documentation available at https://docs.ansible.com/ansible/2.9/modules/win_domain_module.html

Base Command

win-domain

Input

Context Output

Command Example

!win-domain host="123.123.123.123" dns_domain_name="ansible.vagrant" safe_mode_password="password123!"

Context Example

{
    "MicrosoftWindows": {
        "WinDomain": {
            "changed": true,
            "host": "123.123.123.123",
            "reboot_required": true,
            "status": "CHANGED"
        }
    }
}

Human Readable Output

123.123.123.123 - CHANGED

• changed: True
• reboot_required: True

win-domain-computer

Manage computers in Active Directory
Further documentation available at https://docs.ansible.com/ansible/2.9/modules/win_domain_computer_module.html

Base Command

win-domain-computer

Input

Context Output

| Path | Type | Description |
| — | — | — |

win-domain-controller

Manage domain controller/member server state for a Windows host
Further documentation available at https://docs.ansible.com/ansible/2.9/modules/win_domain_controller_module.html

Base Command

win-domain-controller

Input

Context Output

win-domain-group

Creates, modifies or removes domain groups
Further documentation available at https://docs.ansible.com/ansible/2.9/modules/win_domain_group_module.html

Base Command

win-domain-group

Input

Context Output

win-domain-group-membership

Manage Windows domain group membership
Further documentation available at https://docs.ansible.com/ansible/2.9/modules/win_domain_group_membership_module.html

Base Command

win-domain-group-membership

Input

Context Output

win-domain-membership

Manage domain/workgroup membership for a Windows host
Further documentation available at https://docs.ansible.com/ansible/2.9/modules/win_domain_membership_module.html

Base Command

win-domain-membership

Input

Context Output

win-domain-user

Manages Windows Active Directory user accounts
Further documentation available at https://docs.ansible.com/ansible/2.9/modules/win_domain_user_module.html

Base Command

win-domain-user

Input

Context Output

win-dotnet-ngen

Runs ngen to recompile DLLs after .NET updates
Further documentation available at https://docs.ansible.com/ansible/2.9/modules/win_dotnet_ngen_module.html

Base Command

win-dotnet-ngen

Input

Context Output

win-dsc

Invokes a PowerShell DSC configuration
Further documentation available at https://docs.ansible.com/ansible/2.9/modules/win_dsc_module.html

Base Command

win-dsc

Input

Context Output

win-environment

Modify environment variables on windows hosts
Further documentation available at https://docs.ansible.com/ansible/2.9/modules/win_environment_module.html

Base Command

win-environment

Input

Context Output

Command Example

!win-environment host="123.123.123.123" state="present" name="TestVariable" value="Test value" level="machine"

Context Example

{
    "MicrosoftWindows": {
        "WinEnvironment": {
            "before_value": "Test value",
            "changed": false,
            "host": "123.123.123.123",
            "status": "SUCCESS",
            "value": "Test value",
            "values": {
                "TestVariable": {
                    "after": "Test value",
                    "before": "Test value",
                    "changed": false
                }
            }
        }
    }
}

Human Readable Output

123.123.123.123 - SUCCESS

• before_value: Test value
• changed: False

• value: Test value

• Values

  • Testvariable

    • after: Test value
    • before: Test value
    • changed: False

win-eventlog

Manage Windows event logs
Further documentation available at https://docs.ansible.com/ansible/2.9/modules/win_eventlog_module.html

Base Command

win-eventlog

Input

Context Output

Command Example

!win-eventlog host="123.123.123.123" name="MyNewLog" sources="['NewLogSource1', 'NewLogSource2']" state="present"

Context Example

{
    "MicrosoftWindows": {
        "WinEventlog": {
            "changed": false,
            "entries": 0,
            "exists": true,
            "host": "123.123.123.123",
            "maximum_size_kb": 512,
            "name": "MyNewLog",
            "overflow_action": "OverwriteOlder",
            "retention_days": 7,
            "sources": [
                "'NewLogSource2']",
                "MyNewLog",
                "['NewLogSource1'"
            ],
            "sources_changed": [],
            "status": "SUCCESS"
        }
    }
}

Human Readable Output

123.123.123.123 - SUCCESS

• changed: False
• entries: 0
• exists: True
• maximum_size_kb: 512
• name: MyNewLog
• overflow_action: OverwriteOlder

• retention_days: 7

• Sources

  • 0: ‘NewLogSource2’]
  • 1: MyNewLog
  • 2: [‘NewLogSource1’

• Sources_Changed

win-eventlog-entry

Write entries to Windows event logs
Further documentation available at https://docs.ansible.com/ansible/2.9/modules/win_eventlog_entry_module.html

Base Command

win-eventlog-entry

Input

Context Output

| Path | Type | Description |
| — | — | — |

Command Example

!win-eventlog-entry host="123.123.123.123" log="System" source="System" event_id="1234" message="This is a test log entry."

Context Example

{
    "MicrosoftWindows": {
        "WinEventlogEntry": {
            "changed": true,
            "host": "123.123.123.123",
            "msg": "Entry added to log System from source System",
            "status": "CHANGED"
        }
    }
}

Human Readable Output

123.123.123.123 - CHANGED

• changed: True
• msg: Entry added to log System from source System

win-feature

Installs and uninstalls Windows Features on Windows Server
Further documentation available at https://docs.ansible.com/ansible/2.9/modules/win_feature_module.html

Base Command

win-feature

Input

Context Output

Command Example

!win-feature host="123.123.123.123" name="Web-Server" state="present"

Context Example

{
    "MicrosoftWindows": {
        "WinFeature": {
            "changed": false,
            "exitcode": "NoChangeNeeded",
            "feature_result": [],
            "host": "123.123.123.123",
            "reboot_required": false,
            "status": "SUCCESS",
            "success": true
        }
    }
}

Human Readable Output

123.123.123.123 - SUCCESS

• changed: False
• exitcode: NoChangeNeeded
• reboot_required: False

• success: True

• Feature_Result

win-file

Creates, touches or removes files or directories
Further documentation available at https://docs.ansible.com/ansible/2.9/modules/win_file_module.html

Base Command

win-file

Input

Context Output

| Path | Type | Description |
| — | — | — |

Command Example

!win-file host="123.123.123.123" path="C:/Temp/foo.conf" state="touch"

Context Example

{
    "MicrosoftWindows": {
        "WinFile": {
            "changed": true,
            "host": "123.123.123.123",
            "status": "CHANGED"
        }
    }
}

Human Readable Output

123.123.123.123 - CHANGED

• changed: True

win-file-version

Get DLL or EXE file build version
Further documentation available at https://docs.ansible.com/ansible/2.9/modules/win_file_version_module.html

Base Command

win-file-version

Input

Context Output

Command Example

!win-file-version host="123.123.123.123" path="C:\\Windows\\System32\\cmd.exe"

Context Example

{
    "MicrosoftWindows": {
        "WinFileVersion": {
            "file_build_part": "14393",
            "file_major_part": "10",
            "file_minor_part": "0",
            "file_private_part": "0",
            "file_version": "10.0.14393.0 (rs1_release.160715-1616)",
            "host": "123.123.123.123",
            "path": "C:\\Windows\\System32\\cmd.exe",
            "product_version": "10.0.14393.0",
            "status": "SUCCESS"
        }
    }
}

Human Readable Output

123.123.123.123 - SUCCESS

• file_build_part: 14393
• file_major_part: 10
• file_minor_part: 0
• file_private_part: 0
• file_version: 10.0.14393.0 (rs1_release.160715-1616)
• path: C:\Windows\System32\cmd.exe
• product_version: 10.0.14393.0

win-find

Return a list of files based on specific criteria
Further documentation available at https://docs.ansible.com/ansible/2.9/modules/win_find_module.html

Base Command

win-find

Input

Context Output

Command Example

!win-find host="123.123.123.123" paths="c:\\Temp"

Context Example

{
    "MicrosoftWindows": {
        "WinFind": {
            "changed": false,
            "examined": 2,
            "files": [
                {
                    "attributes": "Archive",
                    "checksum": "40c7d97574e7c791d649582912620f7d816829e4",
                    "creationtime": 1624943905.9269967,
                    "exists": true,
                    "extension": ".jpg",
                    "filename": "earthrise.jpg",
                    "hlnk_targets": [],
                    "isarchive": true,
                    "isdir": false,
                    "ishidden": false,
                    "isjunction": false,
                    "islnk": false,
                    "isreadonly": false,
                    "isreg": true,
                    "isshared": false,
                    "lastaccesstime": 1624943905.9269967,
                    "lastwritetime": 1624943905.8957422,
                    "lnk_source": null,
                    "lnk_target": null,
                    "nlink": 1,
                    "owner": "BUILTIN\\Administrators",
                    "path": "C:\\Temp\\earthrise.jpg",
                    "sharename": null,
                    "size": 45108
                }
            ],
            "host": "123.123.123.123",
            "matched": 1,
            "status": "SUCCESS"
        }
    }
}

Human Readable Output

123.123.123.123 - SUCCESS

• changed: False
• examined: 2

• matched: 1

• Files

• Earthrise.Jpg

  • attributes: Archive
  • checksum: 40c7d97574e7c791d649582912620f7d816829e4
  • creationtime: 1624943905.9269967
  • exists: True
  • extension: .jpg
  • filename: earthrise.jpg
  • isarchive: True
  • isdir: False
  • ishidden: False
  • isjunction: False
  • islnk: False
  • isreadonly: False
  • isreg: True
  • isshared: False
  • lastaccesstime: 1624943905.9269967
  • lastwritetime: 1624943905.8957422
  • lnk_source: None
  • lnk_target: None
  • nlink: 1
  • owner: BUILTIN\Administrators
  • path: C:\Temp\earthrise.jpg
  • sharename: None

  • size: 45108

  • Hlnk_Targets

win-firewall

Enable or disable the Windows Firewall
Further documentation available at https://docs.ansible.com/ansible/2.9/modules/win_firewall_module.html

Base Command

win-firewall

Input