Share via

Update-ScannerDatabase

  • Reference
Module:
PurviewInformationProtection

Updates the database schema for the Microsoft Purview Information Protection scanner.

Syntax

Update-ScannerDatabase
      [-Cluster |
      -Profile <String>]
      [-Force]
      [<CommonParameters>]

Description

The Update-ScannerDatabase cmdlet updates the database schema for the Microsoft Purview Information Protection scanner and if required, the scanner service account is also granted delete permissions for the scanner database.

Run this cmdlet after upgrading your Microsoft Purview Information Protection client.

For more information, see Installing the Microsoft Purview Information Protection scanner.

Run this cmdlet with an account that has the database-level role of db_owner for the configuration database that the scanner is using, named AIPScannerUL_<cluster_name>.

Examples

Example 1: Update the scanner after the Microsoft Purview Information Protection client has been upgraded, and set a scanner cluster name

PS C:\> Update-ScannerDatabase -cluster USWEST

This command updates the database schema for the Microsoft Purview Information Protection scanner, and sets the cluster name to USWEST rather than use the default name of the computer.

You are prompted to continue and if you confirm, the scanner then gets is configuration from the USWEST scanner cluster that you configure by using the Microsoft Purview compliance portal.

The Microsoft Purview Information Protection scanner is updated successfully, the scanner database is renamed to AIPScannerUL_USWEST, and the scanner now gets its configuration from the Microsoft Purview Information Protection service.

For reference purposes, a backup of your old configuration is stored in %localappdata%\Microsoft\MSIP\ScannerConfiguration.bak.

Parameters

-Cluster

Specifies the configured name of the scanner's database, used to identify the scanner you want to update.

Use the following syntax: AIPScannerUL_<cluster_name>.

Using either this parameter or the Profile parameter is mandatory. We recommend using this parameter instead of the Profile parameter.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Force

Forces the command to run without asking for user confirmation.

When used, the command first verifies that all nodes under the same cluster are offline. If any nodes are found to be online, a warning is displayed with the node details.

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Profile

Specifies the configured name of the scanner's database, used to identify the scanner you want to update.

Using either this parameter or the Cluster parameter is mandatory. We recommend using the Cluster parameter instead of the this parameter.

The database name for the scanner is AIPScannerUL_<profile_name>.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

Inputs

None

Outputs

System.Object