Get-GPResultantSetOfPolicy

Get-GPResultantSetOfPolicy

Outputs the Resultant Set of Policy (RSoP) information for a user, a computer, or both to a file.

Syntax

Parameter Set: Default
Get-GPResultantSetOfPolicy -Path <String> -ReportType <ReportType> [-Computer <String> ] [-User <String> ] [ <CommonParameters>]

Detailed Description

The Get-GPResultantSetofPolicy cmdlet outputs the Resultant Set of Policy (RSoP) information for a user, a computer, or both to a file.

Parameters

-Computer<String>

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 example, sales.contoso.com\computer-01.

-- NetBIOS domain name\computer name; for example, sales\computer-01.

-- Computer name (host name): for example, computer-01.

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-Path<String>

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

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

Aliases

none

Required?

true

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-ReportType<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 following values are permitted for this object type.

Aliases

none

Required?

true

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-User<String>

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 example, sales.contoso.com\someuser.

-- NetBIOS domain name\user name; for example, sales\someuser.

-- User name: for example, someuser.

Aliases

none

Required?

false

Position?

named

Default Value

none

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.

  • None

    This cmdlet does not take any object as input.

Outputs

The output type is the type of the objects that the cmdlet emits.

  • Microsoft.GroupPolicy.GPRsop

    Get-GPResultantSetOfPolicy returns an RSoP object.

Notes

  • The Get-GPResultantSetofPolicy cmdlet provides only the logging results for a specified computer and user. You must use the GPMC to generate RSoP modeling information.

Examples

-------------------------- EXAMPLE 1 --------------------------

Description

-----------

This command generates a report for the user (CONTOSO\someuser) that is running the session and the computer (COMPUTER-02) on which the session is running. The report is generated in XML format, and is written to the specified file.

C:\PS>get-gpresultantsetofpolicy -reporttype xml -path c:\reports\LocalUserAndComputerReport.xml 

-------------------------- EXAMPLE 2 --------------------------

Description

-----------

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.

C:\PS>Get-GPResultantSetOfPolicy -reporttype xml -computer computer-08.contso.com -path c:\reports\computer-08.xml 

-------------------------- EXAMPLE 3 --------------------------

Description

-----------

This command generates a report for the specified user (contoso\someuser) in HTML format and saves it to the specified file.

C:\PS>Get-GPResultantSetofPolicy -user contoso\someuser -reporttype html -path c:\reports\UserReport.html 

-------------------------- EXAMPLE 4 --------------------------

Description

-----------

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.

C:\PS>Get-GPResultantSetOfPolicy -user someuser -computer contoso.com\computer-08 -reporttype html -path c:\reports\UserAndComputerReport.html