Change Auditor 7.5 - User Guide

Adding the PowerShell module

Adding the PowerShell module

Change Auditor comes with a PowerShell module for you to use to manage your environment. It is installed when you install the Windows client or a coordinator.

NOTE: Windows PowerShell version 3.0 or higher is required.

To import the Change Auditor PowerShell module:

1	Open a Windows PowerShell window and type the following at the Windows PowerShell command prompt:

Import-Module <path>

Where "<path>" is the file path for the ChangeAuditor.PowerShell.dll assembly found in the Change Auditor Windows client or Change Auditor coordinator folder.

2	To ensure that the module was added, type the following at the Windows PowerShell command prompt:

Get-Module -All

The registered PowerShell modules are listed.

Viewing available commands and help

Viewing available commands and help

•	To view all available Change Auditor commands, enter:

Get-Command -Module ChangeAuditor.PowerShell

•	To view help on each command including the syntax, enter:

Get-Help cmdletName

•	To view an interactive command browser that shows you the layout of commands and the help for the commands, enter:

Show-Command cmdletName

 

NOTE: Sample scripts are available in the Change Auditor client folder. By default they are located here: C:\Program Files\Quest\ChangeAuditor\Client\PowerShell Sample Scripts

Installing Change Auditor coordinators and web clients

Installing Change Auditor coordinators and web clients

The following commands allow you to install Change Auditor components.

•	Install-CACoordinator

•	Install-CAWebClient

•	Install-CALicense

Install-CACoordinator

Use this command to install locally a Change Auditor Coordinator.

Table 1. Available parameters

Parameter	Description
-MsiPath	The location to find the coordinator MSI file. The coordinator is installed using this installer.
-SQLAuthDatabaseCredential	Credentials to use for the coordinator to access the SQL Server. Specify when the coordinator should use SQL Authentication mode. NOTE: For Azure SQL Managed Instance (PaaS), SQL Authentication Database Credential or Microsoft Entra ID Credential must be used. The Encrypt connection option will be enabled by default.
-AzureADAuthDatabaseCredential	Credentials to use for the coordinator to access the SQL Server. Specify when the coordinator should use Microsoft Entra authentication mode. NOTE: For Azure SQL Managed Instance (PaaS), SQL Authentication Database Credential or Microsoft Entra ID Credential must be used. The Encrypt connection option will be enabled by default.
-DatabaseCredential	Credentials to use for the coordinator to access the SQL Server. Specify when the coordinator should use Windows Authentication mode. These credentials must be a valid set of Windows credentials..
-DatabaseServer	The SQL Server to host the database.
-LogPath	The local path on the computer where the installation log is written.
-AgentPort (Optional)	The static port for Change Auditor 6.x agents to communicate with the coordinator.
-ClientPort (Optional)	The static port for the Change Auditor client to communicate with the coordinator.
-DatabaseName (Optional)	The name assign to the Change Auditor database.
-InstallationName (Optional)	Name that uniquely identifies the current Change Auditor installation within your Active Directory environment. If this is an additional coordinator in an existing installation (sharing the same database), ensure that you use the name of the existing installation.
-LegacyAgentPort (Optional)	The static port for legacy (5.x) Change Auditor agents to communicate with the coordinator.
-SDKPort (Optional)	The static port used by external applications to access the coordinator

Example: Perform a local installation of a Change Auditor coordinator

Install-CACoordinator -MsiPath "C:\Users\Administrator\Desktop\Quest Change Auditor Coordinator 6 (x64).msi" -SQLAuthDatabaseCredential $dbcredential -DatabaseServer "MyDatabase" -LogPath "C:\Users\Administrator\Desktop\Coordinator.log"

After running this command, the installed coordinator will have the installation name “DEFAULT” and look for or create a database named ChangeAuditor.

Install-CAWebClient

Use this command to install locally the web client.

 

Table 2. Available parameters

Parameter	Description
-LogPath	The local path on the computer where the installation log is written.
-MsiPath	The location to find the web client MSI file. The web client is installed using this installer.
-CoordinatorConnection (Optional)	A previously created connection from Connect-CAClient.
-SiteName (Optional)	The web site name for the Change Auditor web client.
-SitePort (Optional)	A unique port for the web site to avoid conflicts with other IIS applications (for example, SharePoint® uses the default port 80; therefore, the IIS web site for the Change Auditor web client must use a different port). If a conflicting port is specified, attempting to launch the web client displays either an ‘HTTP 404 Not Found’ or ‘Page cannot be displayed’ error.

Example: Install a web client

Install-CAWebClient -MsiPath "C:\Users\Administrator\Desktop\Quest Change Auditor Web Client 6 (x64).msi" -CoordinatorConnection $connection -LogPath "C:\Users\Administrator\Desktop\WebClientInstallationLog.log"

Install-CALicense

Use this command to install licenses to the coordinators in a Change Auditor installation.

 

Table 3. Available parameters

Parameter	Description
-Connection	A connection obtained by using the Connect-CAClient command.
-LicensePath	The license file directory on the client computer.
-Coordinator (Optional)	The single coordinator where you want to install the license (rather than all coordinators).
-Certificate (Optional)	The thumbprint of a client authentication certificate to use instead of automatically searching the current user's personal certificate store.

Example: Install a Change Auditor license in Installation domain, when using certificate authentication

$creds = Get-Credential

$connection = Connect-CAClient -credential $creds

$coordinatorToLicense = Get-CACoordinators -Connection $connection

Install-CALicense $connection –LicensePath 'c:\ChangeAuditor.dlv'

Example: Install license to single coordinator in the Installation which is installed on the local system, when using certificate authentication

$creds = Get-Credential

$connection = Connect-CAClient -SelectLocalCoordinator -credential $creds

$coordinatorToLicense = Get-CACoordinator -Connection $connection

Install-CALicense -Connection $connection -Coordinator $coordinatorToLicense –LicensePath 'c:\ChangeAuditor.dlv'

Example: Install a Change Auditor for Active Directory license

Install-CALicense $connection –LicensePath C:\7_0_AD_license_PER.dlv

Example: Install license to single coordinator in the Installation which is installed on the local system

$connection = Connect-CAClient -SelectLocalCoordinator

$coordinatorToLicense = Get-CACoordinator -Connection $connection

Install-CALicense -Connection $connection -Coordinator $coordinatorToLicense -LicensePath 'c:\7_0_AD_license_PER.dlv'

 

NOTE: Optional Coordinator parameter object must be obtained using Get-CACoordinator command.

Setting the master time zone

Setting the master time zone

Starting with version 6.9, Change Auditor calculates the Next Run of the reports, and archive and purge jobs based on the master time zone. For new deployments, the master time zone is set to the time zone of the server where the first coordinator is being installed. During an upgrade, the master time zone is set to UTC. You can manually change the master time zone, using the set-CAScheduleMasterTimeZone and get-CAScheduleMasterTimeZone commands. We recommend that you set the master time zone to the time zone where most the users are located.

NOTE: Because Daylight Saving Time changes on different dates worldwide, Change Auditor’s schedules follow the time change of that specific time zone.

•	Set-CAScheduleMasterTimeZone

•	Get-CAScheduleMasterTimeZone

Set-CAScheduleMasterTimeZone

Use this command to specify which time zone the coordinators should use to calculate Next Run of the reports and archive and purge jobs.

Table 4. Available parameters

Parameter	Description
-Connection	A connection obtained by using the Connect-CAClient command.
-TimeZoneID	The identifier of a system time zone.
-TimeZoneInfo	A TimeZoneInfo object.

NOTE: The TimeZoneID and TimeZoneInfo parameters must be a system-recognized time zone obtained through a call to the PowerShell command "[System.TimeZoneInfo]::GetSystemTimezones()".

Example: Set the schedule master time zone with a time zone info object

$atlanticTime = [System.TimeZoneInfo]::GetSystemTimeZones() |? {$_.Id -eq "Atlantic Standard Time"}

Set-CAScheduleMasterTimeZone -Connection $connection -TimeZoneInfo $atlanticTime

Example: Set the schedule master time zone with a time zone identifier

Set-CAScheduleMasterTimeZone -Connection $connection -TimeZoneId "Eastern Standard Time"

Get-CAScheduleMasterTimeZone

Use this command to retrieve what time zone the coordinators should use to calculate Next Run of the reports and archive and purge jobs.

Table 5. Available parameters

Parameter	Description
-Connection	A connection obtained by using the Connect-CAClient command.

Example: Retrieve the schedules master time zone

Get-CAScheduleMasterTimeZone -Connection $connection