Update-RmsMfgEnrollment
Update-RmsMfgEnrollment
Updates enrollment information for an AD RMS server enrolled with the Microsoft Federation Gateway service.
Syntax
Parameter Set: Default
Update-RmsMfgEnrollment [-CertificateThumbprint <String> ] [-Force] [-GetDefaultCertificate] [-SetCertificatePermissions] [-SigningCert] [-TokenCert] [-Confirm] [-WhatIf] [ <CommonParameters>]
Detailed Description
The Update-RmsMfgEnrollment cmdlet updates enrollment information for an AD RMS server enrolled with the Microsoft Federation Gateway service.
Parameters
-CertificateThumbprint<String>
Specifies a string containing the thumbprint hash of the certificate being used to update enrollment with the Microsoft Federation Gateway.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
true (ByValue, ByPropertyName) |
Accept Wildcard Characters? |
false |
-Force
Forces the process of updating the enrollment to be completed.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
true (ByValue, ByPropertyName) |
Accept Wildcard Characters? |
false |
-GetDefaultCertificate
When specified, indicates that the thumbprint hash of the AD RMS default certificate should be retrieved and used to update enrollment with the Microsoft Federation Gateway.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
true (ByValue, ByPropertyName) |
Accept Wildcard Characters? |
false |
-SetCertificatePermissions
When specified, indicates that permissions are to be set on the AD RMS server enrollment with the Microsoft Federation Gateway.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
true (ByValue, ByPropertyName) |
Accept Wildcard Characters? |
false |
-SigningCert
When specified, indicates that the Microsoft Federation Gateway signing certificate should be updated (or refreshed in metadata) for the current AD RMS server enrollment.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
true (ByValue, ByPropertyName) |
Accept Wildcard Characters? |
false |
-TokenCert
When specified, indicates that the token decryption certificate should be updated for the AD RMS server enrollment with the Microsoft Federation Gateway.
You can update the token decryption certificate or the Microsoft Federation Gateway certificate, as needed. Because the token decryption certificate is the SSL certificate for the AD RMS cluster, you must update the token decryption certificate if the cluster SSL certificate expires. After you update the token decryption certificate, you must grant the AD RMS Services group permission to access the certificate on all servers in the AD RMS cluster.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
true (ByValue, ByPropertyName) |
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 (https://go.microsoft.com/fwlink/p/?LinkID=113216).
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
- None
Outputs
The output type is the type of the objects that the cmdlet emits.
- None
Examples
-------------- EXAMPLE 1 --------------
Updates the Microsoft Federation Gateway support enrollment for the current AD RMS server by retrieving and using the thumbprint hash of the AD RMS default certificate.
PS C:\> Update-RmsMfgEnrollment -GetDefaultCertificate
-------------- EXAMPLE 2 --------------
Updates the Microsoft Federation Gateway support enrollment for the current AD RMS server using the thumbprint hash of a non-default certificate.
PS C:\> Update-RmsMfgEnrollment -CertificateThumbprint a909502dd82ae41433e6f83886b00d4277a32a7b
-------------- EXAMPLE 3 --------------
Updates the Microsoft Federation Gateway support enrollment for the current AD RMS server using the thumbprint hash of a non-default certificate.
PS C:\> Update-RmsMfgEnrollment -SigningCert
-------------- EXAMPLE 4 --------------
Updates the Microsoft Federation Gateway support enrollment for the current AD RMS server using the thumbprint hash of a non-default certificate.
PS C:\> Update-RmsMfgEnrollment -TokenCert
-------------- EXAMPLE 5 --------------
Sets certificate permissions for the Microsoft Federation Gateway support enrollment for the current AD RMS.
PS C:\> Update-RmsMfgEnrollment -SetCertificatePermissions