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
Default (Default)
Get-RmsEncryptedIL
-ILCertificateId <String>
[-Path] <String[]>
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Description
The Get-RmsEncryptedIL 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 path <PSDrive>:\Report where <PSDrive> is the provider drive ID.
You can also specify a relative path.
For example, a dot (.) 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.
Examples
Example 1: Get use-license information
PS C:\> Get-RmsEncryptedIL -Path "." -ILCertificateId "YJ3HGsG/ADg3rLm5LwWGgpAJmz4=" | Out-File -FilePath "C:\temp\RightsPolicyData.xml"
This command returns use-license information from an issuance license and saves the results in a file.
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 |
-ILCertificateId
Specifies the issuance license certificate hash ID.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | True |
| 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.