Edit

Share via


Update-RmsCluster

Updates the AD RMS cluster information.

Syntax

Default (Default)

Update-RmsCluster
    [-Force]
    [-Path] <String[]>
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Description

The Update-RmsCluster cmdlet updates the cluster information including the hierarchy of content that defines the cluster in Active Directory Rights Management Services (AD RMS). The AD RMS cluster hierarchy is reflected in the directory structure of the provider drive associated with the cluster. For example, you can access the rights policy template information from the RightsPolicyTemplate subdirectory.

To update AD RMS cluster information, set the Path parameter to <PSDrive>:\ where <PSDrive> is the AD RMS provider drive ID associated with the cluster that you want to update.

Examples

Example 1: Update cluster information

PS C:\> Update-RmsCluster -Path "." -Force

This command updates the AD RMS cluster information.

Parameters

-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

-Force

Overrides restrictions that prevent the command from succeeding if the changes do not compromise security.

Parameter properties

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

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:True
Value from pipeline by property name:True
Value from remaining arguments:False

-Path

Specifies a provider drive and path or relative path on the current drive. 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

(All)
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

None

Outputs

None