Uninstall-ADRMS
Removes configuration for an existing deployment of AD RMS Server.
Syntax
Default (Default)
Uninstall-ADRMS
[-ADFSOnly]
[-Credential <PSCredential>]
[-Force]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Description
The Uninstall-ADRMS cmdlet removes configuration for the Active Directory Rights Management Services (AD RMS) server role and, if appropriate, role services that were installed with AD RMS. To remove configuration for Identity Federation Support only, specify the ADFSOnly parameter.
Examples
Example 1: Remove the AD RMS configuration
PS C:\> Uninstall-ADRMS -Force
This command removes the AD RMS configuration on this computer. For more information on using this cmdlet, see Using Windows PowerShell with AD RMS.
Example 2: removes the Identity Federation Support configuration
PS C:\> Uninstall-ADRMS -ADFSOnly -Force
This command removes the Identity Federation Support configuration on this computer.
Parameters
-ADFSOnly
Removes configuration support for Active Directory Federated Services (AD FS) from this computer, but does not otherwise change the AD RMS configuration.
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | 0 |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-Confirm
Prompts you for confirmation before running the cmdlet.
Parameter properties
| Type: | SwitchParameter |
| Default value: | False |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | cf |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-Credential
Specifies user credentials to use for the configuration process. If this parameter is specified, you will be prompted to enter credentials. This parameter operates in a similar manner to the RunAs command.
Parameter properties
| Type: | PSCredential |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | 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).
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | 3 |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Parameter properties
| Type: | SwitchParameter |
| Default value: | False |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | wi |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.
Inputs
SwitchParameter
PSCredential
Notes
- To totally remove the AD RMS role from the system, the Remove-WindowsFeature cmdlet must be run after this cmdlet is used. The command to do so is the
Remove-WindowsFeature ADRMS -IncludeManagementToolscommand.