Edit

Share via

Install-ADRMS

Module:
ADRMS Module

Configures a new deployment of AD RMS Server.

Syntax

MainProvisioningParameterSet 

Install-ADRMS
    [-Path] <String>
    [-Credential <PSCredential>]
    [-Force]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

ADFSProvisioningParameterSet 

Install-ADRMS
    [-ADFSUrl] <String>
    [-Credential <PSCredential>]
    [-Force]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

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.

Examples

Example 1: configures AD RMS

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

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 Using Windows PowerShell with AD RMS.

Example 2: Configure Identity Federation Support and set federation server URL

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

This command configures Identity Federation Support for the AD RMS cluster and sets the federation server URL.

Parameters

-ADFSUrl

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

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

ADFSProvisioningParameterSet
Position:0
Mandatory:True
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

-Path

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.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

MainProvisioningParameterSet
Position:0
Mandatory:True
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

PSCredential

string