Install-ADRMS
Install-ADRMS
Installs and configures AD RMS on this computer
Syntax
Install-ADRMS [-Path] <String> [-Force] [-WhatIf] [-Confirm] [<CommonParameters>]
Install-ADRMS [-ADFSUrl] <String> [-Force] [-WhatIf] [-Confirm] [<CommonParameters>]
Detailed Description
The Install-adrms cmdlet installs the Active Directory Rights Management Services (AD RMS) server role and, if necessary, other required role services. Before running this cmdlet, create a Windows PowerShell drive specifying the ADRmsInstall provider and the type of installation (RootCluster, LicensingCluster, or JoinCluster) as the root, and then set properties on the containers and child items in the drive to specify the initial values for provisioning the server.
To install AD RMS on this computer, set the Path parameter to the ADRmsInstall provider drive subpath “<PSDrive>:\” where <PSDrive> is the provider drive ID. You can also specify a relative path. For example, “.” specifies the current location.
Parameters
-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? |
false |
Position? |
1 |
-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 |
-ADFSUrl <String>
Configures the AD RMS cluster to support Active Directory Federated Services (AD FS) and specifies the extranet cluster URL.
Attributes
| Name | Value |
|---|---|
Required? |
true |
Accept wildcard characters? |
false |
Accept Pipeline Input? |
false |
Position? |
1 |
-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
Examples
Example 1
C:\PS>Install-ADRMS -Path adrmsDrive:\
This command configures AD RMS on by using configuration settings that were previously set on items in the adrmsdrive:\ drive. For more information on using this cmdlet, see https://go.microsoft.com/fwlink/?LinkId=136806.
Example 2
C:\PS>Install-ADRMS -ADFSUrl https://sampleadfsurl.com/federation.asmx -Force
This command adds support for identity federation to the AD RMS cluster and sets the extranet cluster URL. For more information on using this cmdlet, see https://go.microsoft.com/fwlink/?LinkId=136806.