Initialize-RmsCryptoMode2
Prepares an AD RMS server for transitioning to Cryptographic Mode 2.
Syntax
Default (Default)
Initialize-RmsCryptoMode2
-FilePath <String[]>
[-CspName <String>]
[-Regenerate]
[-Force]
[-Path] <String[]>
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Description
The Initialize-RmsCryptoMode2 cmdlet prepares an Active Directory Rights Management Services (AD RMS) server for transitioning to Cryptographic Mode 2.
Cryptographic Mode 2 is an updated and enhanced AD RMS cryptographic implementation. It supports 2048-bit RSA encryption and 256-bit length keys using the SHA-2 hashing algorithm (SHA-2/SHA-256) standards.
While this cmdlet is useful for performing the initial steps required in transitioning an AD RMS deployment to Cryptographic Mode 2, additional tasks are required. First, all client computers in the AD RMS cluster environment must be patched to support this updated and enhanced mode. Depending on your deployment configuration, you may need to update some or all servers. When all computers are updated, as the final transition task to Cryptographic Mode 2, you can run the Update-ADRMS cmdlet with the UpdateCryptographicModeOnly parameter specified to effectively switch the cluster to using mode 2 instead of mode 1.
Examples
Example 1: Export the SLC
PS C:\> Initialize-RmsCryptoMode2 -Path "." -FilePath "c:\test.tud"
This command exports the server licensor certificate (SLC) for the current AD RMS server to the trusted user domain c:\test.tud for a server that uses centrally managed keys.
Example 2: Force regeneration of cryptographic mode 2 keys
PS C:\> Initialize-RmsCryptoMode2 -Path "." -FilePath "c:\test2.tud" -Regenerate
Initialize cryptographic mode 2
This will regenerate the cryptographic mode 2 key pair. Are you sure you want to continue?
[Y] Yes [N] No [S] Suspend [?] Help (default is "Y"):
This command forces regeneration of the cryptographic mode 2 keys.
Parameters
-Confirm
Prompts you for confirmation before running the cmdlet.
Parameter properties
| Type: | SwitchParameter |
| Default value: | False |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | cf |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-CspName
Specifies the name of the cryptographic service provider (CSP) to use for generating the mode 2 TUD when this cmdlet is executed. This CSP must be of the type PROV_RSA_AES to support mode 2 operation (in contrast to mode 1 keys which use the CSP type PROV_RSA_FULL).
The CspName parameter is for CSP-based installs only. If a CSP name is specified for a server with a centrally managed key, an error is returned if this parameter is included in the command.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | True |
| Value from pipeline by property name: | True |
| Value from remaining arguments: | False |
-FilePath
Specifies the name and location for the file generated when this cmdlet is executed. This file contains the mode 2 SLC (server licensor certificate) which is exported as part of transitioning a trusted user domain (TUD) to mode operation.
Parameter properties
| Type: | String[] |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | True |
| Value from pipeline: | True |
| Value from pipeline by property name: | True |
| Value from remaining arguments: | False |
-Force
Forces the cmdlet to save (overwrite) an existing file if one is found to exist under the name and location specified as part of the FilePath parameter.
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | True |
| Value from pipeline by property name: | True |
| Value from remaining arguments: | False |
-Path
This parameter is for CSP-based installs only. If a CSP name is specified for a server with a centrally managed key, an error is returned if this parameter is included in the command.
Parameter properties
| Type: | String[] |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | 0 |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-Regenerate
Forces the AD RMS server to generate a new key even if the cmdlet has previously run. This overwrites any previously generated key. Because you can run this cmdlet multiple times, if this parameter is omitted, the same key is exported each subsequent time the cmdlet is run.
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | True |
| Value from pipeline by property name: | True |
| Value from remaining arguments: | False |
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Parameter properties
| Type: | SwitchParameter |
| Default value: | False |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | wi |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.