Chat now with support
Chat with Support

Change Auditor 7.0.3 - PowerShell Command User Guide

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.

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

-Connection

A connection obtained by using the Connect-CAClient command.

-TimeZoneID

The identifier of a system time zone.

-TimeZoneInfo

A TimeZoneInfo 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"

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

-Connection

A connection obtained by using the Connect-CAClient command.

Get-CAScheduleMasterTimeZone -Connection $connection

 

Finding Change Auditor installations and coordinators

The following commands allow you to find the Change Auditor installations and coordinators available in your Active Directory environment. Once connected, you can run additional commands to manage the deployment.

Use this command to search Active Directory for all available Change Auditor installations. The default is the current computer’s forest, however, you can optionally specify a domain to search cross-forest for deployments.

Find-CAInstallations –DomainName ‘DomainName.com’

Use this command to search Active Directory for all available coordinators. The default is the current computers forest, however, you can optionally specify a domain to search cross-forest for deployments. This search returns all the information required to connect to the coordinator including ports.

Find-CACoordinators -DomainName 'DomainName.com'

Use this command to search Active Directory for a coordinator to which a connection can be made. The default is the current computers forest, however, you can optionally specify a domain to search cross-forest for deployments.

If more than one Change Auditor installation is discovered, the call fails and the –InstallationName parameter is mandatory.

Find-CASuitableCoordinator –InstallationName ‘DEFAULT’

Connecting to and disconnecting from Change Auditor installations and coordinators

Most Change Auditor commands require a connection to a coordinator. This connection can be assigned to a variable and used for any command that requires it. This command searches for a suitable coordinator in a Change Auditor installation and creates a connection. Suitable coordinators are those to which you have access to and can be located by searching through Active Directory service connection points.

You can also connect to Change Auditor installations in untrusted domains or to a specific coordinator by specifying the -ComputerName and -Port parameters.

You can make multiple connections to different coordinators or deployments in the same script as long as the version of Change Auditor is the same.

 

-Credential (Optional)

Windows credentials specifying the user to connect to the Change Auditor installation. All operations using this connection will be authorized as this user. When not specified, the current client running PowerShell is used.

-CoordinatorConnectionPoint

Specify to use a specific coordinator found from a previous call to Find-CACoordinators.

-SelectLocalCoordinator

Create a connection to the local coordinator.

-InstallationName (Optional)

The installation name to connect to. If an installation cannot be found with this name, no connection is made.

If more than one Change Auditor installation exists in the current forest, this parameter is mandatory. Omitting it results in a connection failure due to ambiguity.

-DomainName (Optional)

The name of the domain where the Change Auditor installation exists.

-ComputerName

The computer to connect to.

-Port

The port to connect to.

-WaitForServiceReady (Optional)

The number of seconds to wait for the connected coordinator service to be ready.

 

Recommended: Connect to the installation “XYZ” in the local forest.

Connect-CAClient –InstallationName ‘XYZ’ -DomainName 'DomainName.com'

Connect to the first suitable coordinator found in any installation in any trusted domain.

$connection = Connect-CAClient

Connect to a specific coordinator by computer name and port.

Connect-CAClient –ComputerName ‘ca-cord.DomainName.com’ –Port 52289

Connect to the first suitable coordinator in the domain “DomainName.com”.

Connect-CAClient –DomainName ‘DomainName.com’

 

Connect to the first suitable coordinator in the domain “DomainName.com” with an installation name “DEFAULT”.

Connect-CAClient –DomainName ‘DomainName.com’ –InstallationName ‘DEFAULT’

Connect to a coordinator found from Find-CACoordinators.

$coordinators = Find-CACoordinators –DomainName ‘DomainName.com’

$connection = Connect-CAClient –CoordinatorConnectionPoint $coordinators[0]

Use this command to disconnect from Change Auditor. (This is the equivalent of closing the Change Auditor client.)

$connection = Connect-CAClient –InstallationName ‘DEFAULT’

# perform some actions

Disconnect-CAClient $connection

Managing client authentication options

Change Auditor has two authentication method:

These commands allow you to manage the authentication used in your Change Auditor deployment.

Use this command to view the authentication profile Change Auditor coordinators use in a particular installation.

Returns: An object containing the options for authentication for the specified installation.

-Connection

A connection obtained by using the Connect-CAClient command.

-InstallationName (Optional)

The installation name to connect to. If an installation cannot be found with this name, no connection is made.

If more than one Change Auditor installation exists in the current forest, this parameter is mandatory. Omitting it results in a connection failure due to ambiguity.

-DomainName (Optional)

The name of the domain where the Change Auditor installation exists.

Get-CAAuthenticationOptions –InstallationName ‘DEFAULT’ –DomainName ‘DomainName.com’

Get-CAAuthenticationOptions -Connection $connection

Use this command to alter the authentication profile the Change Auditor coordinators use in a particular installation.

Returns: An object containing the options for authentication for the specified installation.

-Connection

A connection obtained by using the Connect-CAClient command.

-AlwaysChallengeForCredential (Optional)

 

When specified, instructs the coordinator to disallow any connection that is not accompanied by credentials. For PowerShell clients, this means that the Connect-CAClient command will not connect without the use of the
-Credential parameter.

-AllowActiveDirectoryCertificateAuthentication (Optional)

 

When specified, instructs the coordinator to allow certificate authentication via a web client. This switch has no meaning for the Win32 client.

-AllowWindowsFormsAuthentication (Optional)

 

When specified, instructs the coordinator to accept default username/password style of credentials.

-AuthenticationOptions (Optional)

 

 

This parameter allows the caller to pass directly the result of the Get-CAAuthenticationOptions without having to break down the options into their constituent flag values.

Set-CAAuthenticationOptions -Connection $connection -AlwaysChallengeForCredential
-AllowActiveDirectoryCertificateAuthentication -AllowWindowsFormsAuthentication

Set-CAAuthenticationOptions -Connection $connection -AuthenticationOptions $AuthenticationOptions

Related Documents