Set-RmsSvcAccount

Set-RmsSvcAccount

Sets the service account for an AD RMS cluster.

Syntax

Parameter Set: Default
Set-RmsSvcAccount [-Path] <String[]> [-Credential] <PSCredential> [-Force] [-PassThru] [-Confirm] [-WhatIf] [ <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.


Aliases

none

Required?

true

Position?

2

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-Force

Overrides restrictions that prevent the command from succeeding if the restrictions do not compromise security.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

true (ByValue, ByPropertyName)

Accept Wildcard Characters?

false

-PassThru

Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

true (ByValue, ByPropertyName)

Accept Wildcard Characters?

false

-Path<String[]>

Specifies a provider drive and path or relative path on the current drive. Use a dot (.) to specify the current location. This parameter does not accept wildcards and has no default value.


Aliases

none

Required?

true

Position?

1

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: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see    about_CommonParameters.

Inputs

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

Outputs

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

  • PSCredential

Examples

Example 1: Modify the service account

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.


C:\PS>Set-RmsSvcAccount -Path "."

Example 2: Modify the service account with specified credentials

This command changes the AD RMS service account. Because the Credential parameter specifies the domain and user name of the account, the Set-RmsSvcAccount cmdlet prompts for the password of the new service account.


C:\PS>Set-RmsSvcAccount -Path "." -Force -PassThru -Credential ITDOMAIN\adrmssvc

Example 3: Get credentials to use to modify a service account

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.


C:\PS> $userAccount = Get-Credential ITDOMAIN\adrmssvc
C:\PS> Set-RmsSvcAccount -Path "." -Force -PassThru -Credential $userAccount

Related topics

Community Additions

ADD
Show: