Skip to content

Commit 92b0ab2

Browse files
Updated outdated information on ProcessStats, added links to new guide sections (#206)
1 parent bd24057 commit 92b0ab2

File tree

1 file changed

+7
-14
lines changed

1 file changed

+7
-14
lines changed

windows/README.md

+7-14
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,14 @@
11
# Machine Stats for Windows
22

3-
Machine Stats for Windows uses WinRM to `Invoke-Command` across your servers, creating a JSON file to securely send to your [Tidal Migrations](https://tidalmigrations.com/) instance using the [tidal command](https://tidalmigrations.com/tidal-tools/).
3+
Machine Stats for Windows uses WinRM to `Invoke-Command` across your servers, creating a JSON file which you can securely send to your [Tidal Migrations](https://tidalmigrations.com/) instance using the [tidal command](https://tidalmigrations.com/tidal-tools/).
44

5-
The script `runner.ps1` should be customized for each network that you will be scanning.
6-
7-
1) Specify your username (step 1) and a list of hostnames (step 3).
8-
9-
2) If you plan on running this in a scheduled task, you may want to store your credential with the `PsCredential` method. See [this blog post](https://www.interworks.com/blog/trhymer/2013/07/08/powershell-how-encrypt-and-store-credentials-securely-use-automation-scripts) for an example.
10-
11-
> _NB: You do need WinRM enabled across your environment for this._
12-
> _For a simple guide to do this via GPO, see [here](https://support.auvik.com/hc/en-us/articles/204424994-How-to-enable-WinRM-with-domain-controller-Group-Policy-for-WMI-monitoring)._
13-
14-
As of Windows 2008 Server onward [WinRM service starts automatically](https://docs.microsoft.com/en-us/windows/win32/winrm/installation-and-configuration-for-windows-remote-management#configuration-of-winrm-and-ipmi).
5+
If WinRM is not the best solution for you, you can use an alternative approach backed by WMI by running the `-NoWinRM` flag. For more information check out the [guide](https://guides.tidalmg.com/machine_stats.html#gather-machine-stats-without-winrm).
156

167
## Usage
178

18-
1) Download and install [Tidal Tools](https://get.tidal.sh/)
9+
For detailed information on the different ways to run Machine Stats for Windows, check out the [guide](https://guides.tidalmg.com/machine_stats.html#windows). This README will explain one common use case - where you want to take a single reading of your inventory and then pipe the result straight to the Tidal Migrations platform using Tidal Tools.
10+
11+
1) Download and install [Tidal Tools](https://get.tidal.sh/).
1912

2013
2) Make sure you are logged in to your Tidal Migration workspace with 👇 . Check out the [guides](https://guides.tidalmg.com/tidal-tools.html#using-tidal-tools) for more information.
2114
```
@@ -37,7 +30,7 @@ tidal login
3730

3831
You should be able to check your account and see the VMs and their corresponding attributes and metrics. You'll find that at a URL that is something like:
3932

40-
https://your_domain.tidalmg.com/#/servers
33+
`https://your_domain.tidalmg.com/#/servers`
4134

4235
## Data captured
4336

@@ -55,7 +48,7 @@ Operating System Version
5548
CPU name
5649
```
5750

58-
You can also capture information about processes running on the host machine. This feature is disabled by default, to enable it uncomment lines 50 to 67 and line 96 in [windows/server_stats.ps1.](server_stats.ps1). If you do that, it will gather the following information about a process:
51+
You can also capture information about processes running on the host machine. This feature is disabled by default, to enable it use the flag `-ProcessStats`. Note that this will only work when using WinRM, and so can't be used alongside the `-NoWinRM` flag. Running this flag will gather the following information about a process:
5952
```
6053
User
6154
Process Name

0 commit comments

Comments
 (0)