Set-RmsSvcAccount
Set-RmsSvcAccount
Sets the service account for an Active Directory Rights Management Services (AD RMS) cluster.
Syntax
Set-RmsSvcAccount [-Credential] <PSCredential> [-Force] [-PassThru] [-Path] <String[]> [-WhatIf] [-Confirm] [<CommonParameters>]
Detailed Description
The Set-RmsSvcAccount cmdlet sets the service account of an Active Directory Rights Management Services (AD RMS) cluster.
To specify the service account, set the Credential parameter to the service account credentials, and then set the Path parameter to “<PSDrive>:\” where <PSDrive> is the AD RMS provider drive ID.
Parameters
-Credential <PSCredential>
Specifies a user name and password as a PSCredential object.
Attributes
| Name | Value |
|---|---|
Required? |
true |
Accept wildcard characters? |
false |
Accept Pipeline Input? |
false |
Position? |
2 |
-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? |
true (ByValue, ByPropertyName) |
Position? |
named |
-PassThru <SwitchParameter>
Passes the object created by this cmdlet through the pipeline. By default, this cmdlet does not pass any objects through the pipeline.
Attributes
| Name | Value |
|---|---|
Required? |
false |
Accept wildcard characters? |
false |
Accept Pipeline Input? |
true (ByValue, ByPropertyName) |
Position? |
named |
-Path <String[]>
Specifies a provider drive and path or relative path on the current drive. This parameter is required. Use a dot (.) to specify the current location. This parameter does not accept wildcards and has no default value.
Attributes
| Name | Value |
|---|---|
Required? |
true |
Accept wildcard characters? |
false |
Accept Pipeline Input? |
true (ByValue, ByPropertyName) |
Position? |
1 |
-WhatIf <SwitchParameter>
Describes what would happen if you executed the command without actually 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 |
PSCredential. The PSCredential object representing the new AD RMS service account. |
Notes
Examples
EXAMPLE 1
C:\PS>Set-RmsSvcAccount -Path .
This command changes the AD RMS service account. Because the Credential parameter is not used, the Set-RmsSvcAccount cmdlet prompts for the user name and password of the new service account.
EXAMPLE 2
C:\PS>Set-RmsSvcAccount -Path . -Force -PassThru -Credential ITDOMAIN\adrmssvc
This command changes the AD RMS service account. Because the Credential specifies the domain and user name of the account, the Set-RmsSvcAccount cmdlet prompts for the password of the new service account.
EXAMPLE 3
C:\PS>$userAccount = Get-Credential ITDOMAIN\adrmssvc
Set-RmsSvcAccount -Path . -Force -PassThru -Credential $userAccount
This command uses the Get-Credential cmdlet to prompt for the password for the ITDOMAIN\adrmsvc account and then stores the account credentials securely in a variable, which is then passed to the Set-RmsSvcAccount cmdlet.