Get-RmsEncryptedIL
Get-RmsEncryptedIL
Returns use-license information from an issuance license used in a user request for the Active Directory Rights Management Services (AD RMS) cluster.
Syntax
Parameter Set: Default
Get-RmsEncryptedIL [-Path] <String[]> -ILCertificateId <String> [-Confirm] [-WhatIf] [ <CommonParameters>]
Detailed Description
This cmdlet generates a report containing information about an issuance license used in a user request on the Active Directory Rights Management Services (AD RMS) cluster. You must be logged in as an Enterprise Administrator to use this cmdlet.
To obtain licenses, specify the ILCertificateID of the certificate for which you want to obtain use-license information and then set the Path parameter to the AD RMS provider drive subpath “<PSDrive>:\Report” where <PSDrive> is the provider drive ID. You can also specify a relative path. For example, “.” specifies the current location.
Use the Get-RmsCertChain cmdlet to obtain the ILCertificateID of the certificate for which you want to obtain use-license information. The ILCertificateID value returned is valid only for the cluster identified by the Path parameter of Get-RmsCertChain. You cannot use an ILCertificateID to identify the same certificate in different clusters.
Parameters
-ILCertificateId<String>
Specifies the issuance license certificate hash ID.
Aliases |
none |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
true (ByValue, ByPropertyName) |
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 (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.
Outputs
The output type is the type of the objects that the cmdlet emits.
Examples
-------------- EXAMPLE 1 --------------
This command returns use-license information from an issuance license and saves the results in a file.
C:\PS>Get-RmsEncryptedIL -Path . -ILCertificateId "YJ3HGsG/ADg3rLm5LwWGgpAJmz4=" | Out-File -FilePath C:\temp\RightsPolicyData.xml
Related topics
com/fwlink/?LinkId=136806