Update-ADRMS
Update-ADRMS
Upgrades AD RMS following a Windows upgrade
Syntax
Update-ADRMS [-ServiceAccount] <PSCredential> [[-PrivateKeyPassword] <SecureString>] [-Force] [-WhatIf] [-Confirm] [<CommonParameters>]
Detailed Description
The Update-ADRMS cmdlet upgrades the Active Directory Rights Management Services (AD RMS) server role on a server that has been upgraded to this version of Windows.
Parameters
-ServiceAccount <PSCredential>
Specifies the AD RMS service account used in AD RMS configuration as a PSCredential object.
Attributes
| Name | Value |
|---|---|
Required? |
true |
Accept wildcard characters? |
false |
Accept Pipeline Input? |
false |
Position? |
2 |
-PrivateKeyPassword <SecureString>
Specifies the cluster key password as a SecureString object. To create a SecureString object that contains a password, use the Read-Host cmdlet and specify the AsSecureString parameter.
Attributes
| Name | Value |
|---|---|
Required? |
false |
Accept wildcard characters? |
false |
Accept Pipeline Input? |
false |
Position? |
3 |
-Force <SwitchParameter>
Overrides restrictions that prevent the command from succeeding, just so the changes do not compromise security.
Attributes
| Name | Value |
|---|---|
Required? |
false |
Accept wildcard characters? |
false |
Accept Pipeline Input? |
false |
Position? |
1 |
-WhatIf <SwitchParameter>
Describes what would happen if you executed the command without executing the command.
Attributes
| Name | Value |
|---|---|
Required? |
false |
Accept wildcard characters? |
false |
Accept Pipeline Input? |
false |
Position? |
named |
-Confirm <SwitchParameter>
Prompts you for confirmation before executing the command.
Attributes
| Name | Value |
|---|---|
Required? |
false |
Accept wildcard characters? |
false |
Accept Pipeline Input? |
false |
Position? |
named |
-CommonParameter
This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see About Common Parameter
Input and Return Types
The input type is the type of the objects that you can pipe to the cmdlet. The return type is the type of the objects that the cmdlet emits.
Input Type |
. |
Return Type |
. |
Notes
- You must supply the credentials for the AD RMS service account and, if the key is stored locally, the AD RMS cluster key.
Examples
Example 1
PS C:\$mysecurestringpassword = read-host –assecurestring
PS C:\$mycred = get-credential //this cmdlet will open a popup window for user to enter username and password
PS C:\Update-adrms -privatekeypassword $mysecurestringpassword –serviceaccount $mycred
This command upgrades AD RMS on this computer following an operating-system upgrade. For more information on using this command, see https://go.microsoft.com/fwlink/?LinkId=136806.