Update-RmsCluster
Update-RmsCluster
Updates the Active Directory Rights Management Services (AD RMS) cluster information.
Syntax
Update-RmsCluster [-Force] [-Path] <String[]> [-WhatIf] [-Confirm] [<CommonParameters>]
Detailed 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.
Parameters
-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? |
true (ByValue, ByPropertyName) |
Position? |
named |
-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? |
true (ByValue, ByPropertyName) |
Position? |
1 |
-WhatIf <SwitchParameter>
Describes what would happen if you executed the command without actually 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 |
-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>Update-RmsCluster -Path . -Force
This command updates the AD RMS cluster information.