Export (0) Print
Expand All

Update-ADRMS

Updated: August 15, 2012

Applies To: Windows Server 2012

Update-ADRMS

Updates an existing deployment of AD RMS Server.

Syntax

Parameter Set: Default
Update-ADRMS [-ServiceAccount] <PSCredential> [[-PrivateKeyPassword] <SecureString> ] [[-NewCspName] <String> ] [[-Force]] [-Credential <PSCredential> ] [-UpdateCryptographicModeOnly] [-Confirm] [-WhatIf] [ <CommonParameters>]




Detailed Description

The Update-ADRMS cmdlet updates the Active Directory Rights Management Services (AD RMS) server role on a server that has been upgraded to this version of Windows. The cmdlet can also be used to update the AD RMS cryptographic mode on a server.

Parameters

-Credential<PSCredential>

Specifies user credentials to use for the update process. If this parameter is specified, you will be prompted to enter credentials. This parameter operates in a similar manner to the RunAs command.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-Force

Forces completion of the command by overriding restrictions that would prevent it from succeeding (so long as a the changes made do not compromise security).


Aliases

none

Required?

false

Position?

4

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-NewCspName<String>

Specifies the new name of the cryptographic service provider (CSP) to use for storing the private key of the AD RMS server. This parameter is used in combination with the –UpdateCryptographicMode parameter for AD RMS servers that are using CSP key storage.


Aliases

none

Required?

false

Position?

3

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-PrivateKeyPassword<SecureString>

Specifies the password for the AD RMS centrally managed key.


Aliases

none

Required?

false

Position?

2

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-ServiceAccount<PSCredential>

Specifies the identity of the domain account that is used for the AD RMS service account.


Aliases

none

Required?

true

Position?

1

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-UpdateCryptographicModeOnly

If set, indicates that only the cryptographic mode of the server is to be updated. To update the cryptographic mode of an AD RMS server, you must be logged in with an account that has membership in the local AD RMS Enterprise Administrators Group on that server. If the AD RMS server is using CSP key storage, the –NewCspName parameter should also be specified.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

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.

  • SwitchParameter, string, PSCredential, SecureString

Examples

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

Description

-----------

Upgrades an AD RMS server and cluster that is using a cluster key password. The password must be specified securely as console input. The Get-Credential cmdlet will launch a popup dialog to enter the AD RMS Service Account credentials (username and password) that are also required to upgrade AD RMS.


C:\PS>$mySecureStringPassword = ConvertTo-SecureString –String <password> -AsPlainText -Force$myCred = Get-CredentialUpdate-ADRMS -PrivateKeyPassword $mySecureStringPassword -ServiceAccount $myCred

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

Description

-----------

Updates an AD RMS server that is using a cluster key password to cryptographic mode 2. The Get-Credential command will launch a popup dialog to enter the AD RMS Service Account credentials (username and password) which are required for this update. The cluster key password is not required; but if the server is using CSP key storage, the –NewCspName parameter must be included.


C:\PS>$myCred = Get-CredentialUpdate-ADRMS -UpdateCryptographicModeOnly -ServiceAccount $myCred

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