Export (0) Print
Expand All

Initialize-RmsCryptoMode2

Windows Server 2012 R2 and Windows 8.1

Updated: June 4, 2014

Applies To: Windows 8.1, Windows PowerShell 4.0, Windows Server 2012 R2

Initialize-RmsCryptoMode2

Prepares an AD RMS server for transitioning to Cryptographic Mode 2.

Syntax

Parameter Set: Default
Initialize-RmsCryptoMode2 -FilePath <String[]> [-CspName <String> ] [-Force] [-Regenerate] [-Confirm] [-WhatIf] [ <CommonParameters>]




Detailed Description

The Initialize-RmsCryptoMode2 cmdlet prepares an 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, some or all servers might need to be updated as well. When all computers have been updated, as a 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.

Parameters

-CspName<String>

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).

Note that 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.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

true (ByValue, ByPropertyName)

Accept Wildcard Characters?

false

-FilePath<String[]>

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.


Aliases

none

Required?

true

Position?

named

Default Value

none

Accept Pipeline Input?

true (ByValue, ByPropertyName)

Accept Wildcard Characters?

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.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

true (ByValue, ByPropertyName)

Accept Wildcard Characters?

false

-Regenerate

Forces the AD RMS server to generate a new key even if the cmdlet has already been run previously. This overwrites any previously generated key. Since this cmdlet can be run multiple times, if this parameter is omitted, the same key will be exported each subsequent time the cmdlet is run.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

true (ByValue, ByPropertyName)

Accept Wildcard Characters?

false

-Confirm

Prompts you for confirmation before running the cmdlet.


Required?

false

Position?

named

Default Value

false

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.


Required?

false

Position?

named

Default Value

false

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

<CommonParameters>

This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see    about_CommonParameters.

Inputs

The input type is the type of the objects that you can pipe to the cmdlet.

  • string[], string, bool, SwitchParameter

Outputs

The output type is the type of the objects that the cmdlet emits.

  • None

Examples

-------------- EXAMPLE 1 --------------

Exports the server licensor certificate (SLC) for the current AD RMS server to the c:\test.tud for a server that uses centrally managed keys.


PS C:\> Initialize-RmsCryptoMode2 -path . -FilePath c:\test.tud

-------------- EXAMPLE 2 --------------

Forces regeneration of the 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"):

Related topics

Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft