Uninstall-ADRMS
Uninstall-ADRMS
Removes configuration for an existing deployment of AD RMS Server.
Syntax
Parameter Set: Default
Uninstall-ADRMS [[-ADFSOnly]] [[-Force]] [-Credential <PSCredential> ] [-Confirm] [-WhatIf] [ <CommonParameters>]
Detailed 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.
Parameters
-ADFSOnly
Removes configuration support for Active Directory Federated Services (AD FS) from this computer, but does not otherwise change the AD RMS configuration.
Aliases |
none |
Required? |
false |
Position? |
1 |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-Credential<PSCredential>
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.
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 |
-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 (https://go.microsoft.com/fwlink/p/?LinkID=113216).
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
- SwitchParameter, PSCredential
Outputs
The output type is the type of the objects that the cmdlet emits.
Notes
- To totally remove the 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 –IncludeManagementTools command.
Examples
-------------------------- EXAMPLE 1 --------------------------
Description
-----------
This command removes the configuration on this computer. For more information on using this cmdlet, see https://go.microsoft.com/fwlink/?LinkId=136806
C:\PS>Uninstall-ADRMS -Force
-------------------------- EXAMPLE 2 --------------------------
Description
-----------
This command removes the Identity Federation Support configuration on this computer. For more information on using this cmdlet, see https://go.microsoft.com/fwlink/?LinkId=136806
C:\PS>Uninstall-ADRMS -ADFSOnly -Force