Module Installation

How to install module

*** It is not recommended to download this module from here unless you intend to send PR's to the repo for changes / fixes. ***

The module is hosted at the PowerShell Gallery and can be installed from a PS CMD Prompt.

Install from PowerShell gallery

1. Open an elevated PS CMD Prompt (Run As Administrator)
2. Install Module: Install-Module PSADHealth
3. Import the Module cmdlets: Import-Module PSADHealth
4. Verify Module is loaded by listing cmdlets: get-command -module PSADHealth
5. Run Get-ADConfig to see the default values included in module config JSON.
6. Run Set-PSADHealthConfig to change/specify the values you want to use

• IMPORTANT NOTE ABOUT CHANGING THE VALUES IN THE JSON FILE:
  Make sure when you run Set-PSADHelathConfig that you are running as administrator. The cmdlet needs admin privileges in order to update the included config.json file. If you do not Run As Administrator, the cmdlet will create a new ADconfig.json and store in the userprofile directory of the current user instead of updating the existing ADconfig.json . However, the functions in the module will not read the newly created ADconfig.json and instead keep reading from the included ADconfig.json file that was created when the module was installed.

8. Verify the values you set are loaded. Get-ADConfig -ConfigurationFile c:\users\%username%\adconfig.json

9. Configure Scheduled Tasks or Scheduled Jobs to run the tests at intervals you choose.