Export (0) Print
Expand All

Install-ADRMS

Windows Server 2012 R2 and Windows 8.1

Updated: October 17, 2013

Applies To: Windows 8.1, Windows PowerShell 4.0, Windows Server 2012 R2

Install-ADRMS

Configures a new deployment of AD RMS Server.

Syntax

Parameter Set: ADFSProvisioningParameterSet
Install-ADRMS [-ADFSUrl] <String> [[-Force]] [-Credential <PSCredential> ] [-Confirm] [-WhatIf] [ <CommonParameters>]

Parameter Set: MainProvisioningParameterSet
Install-ADRMS [-Path] <String> [[-Force]] [-Credential <PSCredential> ] [-Confirm] [-WhatIf] [ <CommonParameters>]




Detailed Description

The Install-ADRMS cmdlet configures the Active Directory Rights Management Services (AD RMS) server role. 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.

Parameters

-ADFSUrl<String>

Configures the AD RMS cluster to support Active Directory Federation Services (AD FS) and specifies the federation server URL.


Aliases

none

Required?

true

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

-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.


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

Inputs

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

  • string, PSCredential

Outputs

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

Examples

-------------------------- EXAMPLE 1 --------------------------

Description

-----------

This command configures AD RMS by using configuration settings that were previously set on items in the adrmsdrive:\ drive. For more information on using this cmdlet, see http://go.microsoft.com/fwlink/?LinkId=136806.


C:\PS>Install-ADRMS -Path adrmsDrive:\

-------------------------- EXAMPLE 2 --------------------------

Description

-----------

This command configures Identity Federation Support for the AD RMS cluster and sets the federation server URL. For more information on using this cmdlet, see http://go.microsoft.com/fwlink/?LinkId=136806.


C:\PS>Install-ADRMS -ADFSUrl https://sampleadfsurl.com -Force

Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft