Get-GPResultantSetOfPolicy

Reference

Module:: GroupPolicy

Gets and writes the RSoP information for a user, a computer, or both to a file.

Syntax

Get-GPResultantSetOfPolicy
   [-Computer <String>]
   [-User <String>]
   -ReportType <ReportType>
   -Path <String>
   [<CommonParameters>]

Description

The Get-GPResultantSetOfPolicy cmdlet gets and writes the Resultant Set of Policy (RSoP) information for a user, a computer, or both to a file.

Examples

Example 1: Generate a report for the default user that is running on the current session

Get-GPResultantSetOfPolicy -ReportType Xml -Path "c:\reports\LocalUserAndComputerReport.xml"

RsopMode        : Logging 
Namespace       : \\COMPUTER-02-PC\Root\Rsop\NS2BBE3F29_794F_4EAE_B9DB_0A2310622534 
LoggingComputer : COMPUTER-02 
LoggingUser     : CONTOSO\someuser 
LoggingMode     : UserAndComputer

This command generates a report for the default user that is running on the current session. The report is generated in XML format, and is written to the specified file.

Example 2: Generate a report for the specified computer

$params = @{
    ReportType = 'Xml'
    Path       = 'c:\reports\computer-08.xml'
    Computer   = 'computer-08.contso.com'
}
Get-GPResultantSetOfPolicy @params

RsopMode        : Logging 
Namespace       : \\computer-08.contoso.com\Root\Rsop\NS643B2E66_8F54_4407_A813_7D47173B0922 
LoggingComputer : computer-08.contoso.com 
LoggingUser     : CONTOSO\Administrator 
LoggingMode     : Computer

This command generates a report for the specified computer. The computer is specified by its fully qualified domain name (FQDN), computer-08.contoso.com. The report is generated in XML format, and is written to the specified file.

Example 3: Generate a report for the specified user in HTML format and save it to the specified file

$params = @{
    ReportType = 'HTML'
    Path       = 'c:\reports\UserReport.html'
    User       = 'Contoso\PattiFul'
}
Get-GPResultantSetOfPolicy @params

RsopMode        : Logging 
Namespace       : \\COMPUTER-02\Root\Rsop\NS78355E76_C754_41B5_8F5E_B61551837A62 
LoggingComputer : COMPUTER-02 
LoggingUser     : contoso\someuser 
LoggingMode     : User

This command generates a report for the specified user Contoso\PattiFul in HTML format and saves it to the specified file.

Example 4: Generate a report for the specified computer and user in HTML format and save it to the specified file

$params = @{
    ReportType = 'HTML'
    Path       = 'c:\reports\UserAndComputerReport.xml'
    User       = 'SomeUser'
    Computer   = 'contoso.com\computer-08'
}
Get-GPResultantSetOfPolicy @params

RsopMode        : Logging 
Namespace       : \\computer-08\Root\Rsop\NS72116C25_6570_4586_9B79_FC4F71372E57 
LoggingComputer : contoso.com\computer-08 
LoggingUser     : someuser 
LoggingMode     : UserAndComputer

This command generates a report for the specified computer contoso.com\computer-08 and user SomeUser in HTML format and saves it to the specified file.

Parameters

-Computer

Specifies the name of the computer for which to generate the report. You can specify the computer name in one of the following formats:

Full computer name (FQDN computer name); for example, computer-01.sales.contoso.com.
Fully qualified domain name (FQDN)\computer name; for instance, sales.contoso.com\computer-01.
NetBIOS domain name\computer name; for instance, sales\computer-01.
Computer name (host name): for instance, computer-01.

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Path

Specifies the path to the report file; for instance, c:\Reports\GpRsopReport.xml.

You can also refer to the Path parameter by its built-in alias, FilePath. For more information, see about_Aliases.

Type:	String
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-ReportType

Specifies the format of the RSoP report. You must specify either Html (for HTML format) or Xml (for XML format). These values are not case sensitive.

The acceptable values for this parameter are: Html or Xml.

Type:	ReportType
Accepted values:	Xml, Html
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-User

Specifies the user name of the user for which to generate the report. You can specify the user name in one of the following formats:

Fully qualified domain name (FQDN)\user name; for instance, sales.contoso.com\SomeUser.
NetBIOS domain name\user name; for example, sales\SomeUser.
User name: for example, SomeUser.

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

Inputs

None

This cmdlet does not take any object as input.

Outputs

Microsoft.GroupPolicy.GPRsop

This cmdlet returns an RSoP object.

Notes

This cmdlet provides only the logging results for a specified computer and user. You must use the GPMC to generate RSoP modeling information.

Share via