Share via


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

Get-RmsEncryptedIL -ILCertificateId <String> [-Path] <String[]> [-WhatIf] [-Confirm] [<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.

Attributes

Name Value

Required?

true

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 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>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.

See Also

Reference

Get-RmsUserRequestReport
Get-RmsRequestInfo
Get-RmsCertChain
Get-RmsCertInfo
Get-RmsChildCert
com/fwlink/?LinkId=136806