Get-RmsChildCert
Get-RmsChildCert is accessible with the help of ADRMSAdmin module. To install ADRMSAdmin on your system please refer to this ADRMSAdmin.
Synopsis
Returns all child certificates from a parent certificate used in a user request for the Active Directory Rights Management Services (AD RMS) cluster.
Description
This cmdlet returns all issuance licenses from a parent client licensor certificate (CLC) or all end-user licenses (EULs) from a parent issuance license used in a user request on the Active Directory Rights Management Services (AD RMS) cluster.
To obtain licenses, specify the ParentCertID and ParentCertType of the parent certificate for which you want to retrieve child certificates and then set the Path parameter to the AD RMS provider drive subpath “:\Report” where 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 ParentCertID and the ParentCertType of the certificate for which you to retrieve child certificates. The ParentCertID value returned is valid only for the cluster identified by the Path parameter of Get-RmsCertChain. You cannot use a ParentCertID to identify the same certificate in different clusters.
Parameters
-EndTime
Specifies the end of a time period for a system health report. This parameter specifies a time value. See the description of the StartTime parameter for information on specifying a time.
Required? false
Position? named
Default value
Accept pipeline input? true (ByValue, ByPropertyName)
Accept wildcard characters? false
-ParentCertId <String>
Specifies the parent certificate for which child certificates are to be returned.
Required? true
Position? named
Default value
Accept pipeline input? true (ByValue, ByPropertyName)
Accept wildcard characters? false
-ParentCertType <String>
Specifies the type of parent certificate for which child certificates are to be returned. Possible values for this parameter are Client-Licensor-Certificate (or CLC) or Issuance-License (or IL).
Required? true
Position? named
Default value
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.
Required? true
Position? 1
Default value
Accept pipeline input? false
Accept wildcard characters? false
-StartTime <DateTime>
Specifies the beginning of a time period. This parameter specifies a time value.
Required? false
Position? named
Default value
Accept pipeline input? true (ByValue, ByPropertyName)
Accept wildcard characters? false
-Confirm <SwitchParameter>
Prompts you for confirmation before running the cmdlet.
Required? false
Position? named
Default value false
Accept pipeline input? false
Accept wildcard characters? false
-WhatIf <SwitchParameter>
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
Syntax
Get-RmsChildCert [-StartTime <DateTime>] [-EndTime <DateTime>] -ParentCertId <String> -ParentCertType <String> [-Path] <String[]> [-WhatIf] [-Confirm] [<CommonParameters>]
————– EXAMPLE 1 ————–
C:\PS>Get-RmsChildCert -Path . -parentCertId <Parent certificate ID> -ParentCertType CLC
This command returns all child certificates from a parent client Licensor certificate.
————– EXAMPLE 2 ————–
C:\PS>$parentCert = Get-RmsCertChain -Path . -RequestID 3 | Where {$_.CertificateType -eq ‘Client-Licensor-Certificate’}
Get-RmsChildCert -Path . -ParentCertId $parentCert.CertificateID -ParentCertType $parentCert.CertificateType
This command stores a certificate obtained from the Get-RmsCertChain cmdlet in a variable and then uses that variable to pass the certificate ID and type to the Get-RmsChildCert cmdlet to return child certificates.
You can check the Version, CommandType and Source of this cmdlet by giving below command.
Get-Command Get-RmsChildCert
You can also read about
- Get-RmsCertChain
- Get-RmsCertInfo
- Get-RmsUserRequestReport