API Reference
Command
Get-ADXGpoResult
File-level doc: Get-ADXGpoResult cmdlet wrapper over the ADPlayground engine. Computes effective Group Policy (Single or Pair) and surfaces engine-shaped views.
Examples
Example 1: Policies view for an OU (with Sites)
Get-ADXGpoResult -DistinguishedName "OU=Servers,DC=contoso,DC=com" -IncludeSites -View Policies
Example 2: gpresult-style report for a user/computer pair
Get-ADXGpoResult -UserDn "CN=Alice,OU=Users,DC=contoso,DC=com" -ComputerDn "CN=SRV01,OU=Servers,DC=contoso,DC=com" -View GpResult
Example 3: Preferences precedence (last-writer) with compact projection
Get-ADXGpoResult -DistinguishedName "OU=Servers,DC=contoso,DC=com" -Scope Computer -View PreferencesPrecedence -Category "Preferences.*" -Key "*Printers*" -Minimal
Example 4: Forest inventory (GPOZaurr parity)
Get-ADXGpoResult -View Inventory -IncludeHealth -Minimal
Common Parameters
This command supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable.
For more information, see about_CommonParameters.
Syntax
Get-ADXGpoResult -DistinguishedName <string> [-Action <string>] [-AdmxDirectory <string>] [-Category <string>] [-Domain <string>] [-EvaluateApplicability] [-IncludeSites] [-Key <string>] [-Language <string>] [-MatchedOnly] [-Minimal] [-Scope <Computer|User>] [-ShowApplicabilityTrace] [-Sites <string[]>] [-SupportedOnly] -View <Raw> [<CommonParameters>]Parameter set:
By DistinguishedNameParameters
- DistinguishedName string
- Target distinguished name (OU, site, or computer/user DN) for Single evaluation.
- Action string
- Optional wildcard to filter PreferencesTrace by Action (Create/Update/Replace/Delete).
- AdmxDirectory string
- Optional ADMX/ADML directory; auto-resolved when omitted.
- Category string
- Wildcard filter for category/policy display/name (used by engine projector).
- Domain string
- DNS domain name; when omitted, resolves from the current machine.
- EvaluateApplicability SwitchParameter
- Evaluate security filtering and WMI filtering (Applicability).
- IncludeSites SwitchParameter
- Include site‑linked GPOs in the evaluation.
- Key string
- Optional wildcard to filter PreferencesTrace by Key.
- Language string
- Preferred ADML language (e.g., en-US).
- MatchedOnly SwitchParameter
- When set with View=PreferencesTrace, returns only items where targeting matched.
- Minimal SwitchParameter
- Emit compact rows for some views (engine projector honors this).
- Scope RegistryPolicyScope
- Policy scope for Single evaluation. Possible values: Computer, User
- Possible values:
Computer,User - ShowApplicabilityTrace SwitchParameter
- Include applicability trace in the output (decision sources and reasons).
- Sites string[]
- Optional list of site names to consider when -IncludeSites is set.
- SupportedOnly SwitchParameter
- Return only policies marked as Supported on the target OS.
- View AdxGpoResultView
- Optional view selector; engine enum living in ADPlayground. Raw|GpResult|GpResultSummary|DictionarySecurityCore|Inventory are special; others are engine-projected views. Possible values: None, Raw, GpResult, GpResultSummary, DictionarySecurityCore, DictionaryNetworkCore, Inventory, Settings, Unknown, Coverage, Summary, Policies, Applied, Denied, Trace, Sites, Preferences, PreferencesTrace, PreferencesPrecedence, Audit, Rights, Certificates, Software, FolderRedirection, Scripts, WindowsUpdate, Defender, Firewall, FirewallDetails, FirewallRules, TimeService, AppLocker, AppLockerRules, DnsClient, Health, Permissions, LinkHealth
- Possible values:
Raw,GpResult,GpResultSummary,DictionarySecurityCore,DictionaryNetworkCore,Inventory,Settings,Unknown,Coverage,Summary,Policies,Applied,Denied,Trace,Sites,Preferences,PreferencesTrace,PreferencesPrecedence,Audit,Rights,Certificates,Software,FolderRedirection,Scripts,WindowsUpdate,Defender,Firewall,FirewallDetails,FirewallRules,TimeService,AppLocker,AppLockerRules,DnsClient,Health,Permissions,LinkHealth
Outputs
ADPlayground.Gpo.GpoInventoryRollupReport, ADPlayground.Gpo.GpoResultPairReport, ADPlayground.Gpo.GpoResultReport
Get-ADXGpoResult -ComputerDn <string> -UserDn <string> [-Action <string>] [-AdmxDirectory <string>] [-Category <string>] [-Domain <string>] [-EvaluateApplicability] [-IncludeSites] [-Key <string>] [-Language <string>] [-MatchedOnly] [-Minimal] [-ShowApplicabilityTrace] [-Sites <string[]>] [-SupportedOnly] -View <Raw> [<CommonParameters>]Parameter set:
By ComputerDn + UserDnParameters
- ComputerDn string
- Computer distinguished name for Pair evaluation.
- UserDn string
- User distinguished name for Pair evaluation.
- Action string
- Optional wildcard to filter PreferencesTrace by Action (Create/Update/Replace/Delete).
- AdmxDirectory string
- Optional ADMX/ADML directory; auto-resolved when omitted.
- Category string
- Wildcard filter for category/policy display/name (used by engine projector).
- Domain string
- DNS domain name; when omitted, resolves from the current machine.
- EvaluateApplicability SwitchParameter
- Evaluate security filtering and WMI filtering (Applicability).
- IncludeSites SwitchParameter
- Include site‑linked GPOs in the evaluation.
- Key string
- Optional wildcard to filter PreferencesTrace by Key.
- Language string
- Preferred ADML language (e.g., en-US).
- MatchedOnly SwitchParameter
- When set with View=PreferencesTrace, returns only items where targeting matched.
- Minimal SwitchParameter
- Emit compact rows for some views (engine projector honors this).
- ShowApplicabilityTrace SwitchParameter
- Include applicability trace in the output (decision sources and reasons).
- Sites string[]
- Optional list of site names to consider when -IncludeSites is set.
- SupportedOnly SwitchParameter
- Return only policies marked as Supported on the target OS.
- View AdxGpoResultView
- Optional view selector; engine enum living in ADPlayground. Raw|GpResult|GpResultSummary|DictionarySecurityCore|Inventory are special; others are engine-projected views. Possible values: None, Raw, GpResult, GpResultSummary, DictionarySecurityCore, DictionaryNetworkCore, Inventory, Settings, Unknown, Coverage, Summary, Policies, Applied, Denied, Trace, Sites, Preferences, PreferencesTrace, PreferencesPrecedence, Audit, Rights, Certificates, Software, FolderRedirection, Scripts, WindowsUpdate, Defender, Firewall, FirewallDetails, FirewallRules, TimeService, AppLocker, AppLockerRules, DnsClient, Health, Permissions, LinkHealth
- Possible values:
Raw,GpResult,GpResultSummary,DictionarySecurityCore,DictionaryNetworkCore,Inventory,Settings,Unknown,Coverage,Summary,Policies,Applied,Denied,Trace,Sites,Preferences,PreferencesTrace,PreferencesPrecedence,Audit,Rights,Certificates,Software,FolderRedirection,Scripts,WindowsUpdate,Defender,Firewall,FirewallDetails,FirewallRules,TimeService,AppLocker,AppLockerRules,DnsClient,Health,Permissions,LinkHealth
Outputs
ADPlayground.Gpo.GpoInventoryRollupReport, ADPlayground.Gpo.GpoResultPairReport, ADPlayground.Gpo.GpoResultReport
Get-ADXGpoResult -ComputerOu <string> -UserOu <string> [-Action <string>] [-AdmxDirectory <string>] [-Category <string>] [-Domain <string>] [-EvaluateApplicability] [-IncludeSites] [-Key <string>] [-Language <string>] [-MatchedOnly] [-Minimal] [-ShowApplicabilityTrace] [-Sites <string[]>] [-SupportedOnly] -View <Raw> [<CommonParameters>]Parameter set:
By ComputerOu + UserOuParameters
- ComputerOu string
- Computer OU distinguished name for Pair-by-OU evaluation.
- UserOu string
- User OU distinguished name for Pair-by-OU evaluation.
- Action string
- Optional wildcard to filter PreferencesTrace by Action (Create/Update/Replace/Delete).
- AdmxDirectory string
- Optional ADMX/ADML directory; auto-resolved when omitted.
- Category string
- Wildcard filter for category/policy display/name (used by engine projector).
- Domain string
- DNS domain name; when omitted, resolves from the current machine.
- EvaluateApplicability SwitchParameter
- Evaluate security filtering and WMI filtering (Applicability).
- IncludeSites SwitchParameter
- Include site‑linked GPOs in the evaluation.
- Key string
- Optional wildcard to filter PreferencesTrace by Key.
- Language string
- Preferred ADML language (e.g., en-US).
- MatchedOnly SwitchParameter
- When set with View=PreferencesTrace, returns only items where targeting matched.
- Minimal SwitchParameter
- Emit compact rows for some views (engine projector honors this).
- ShowApplicabilityTrace SwitchParameter
- Include applicability trace in the output (decision sources and reasons).
- Sites string[]
- Optional list of site names to consider when -IncludeSites is set.
- SupportedOnly SwitchParameter
- Return only policies marked as Supported on the target OS.
- View AdxGpoResultView
- Optional view selector; engine enum living in ADPlayground. Raw|GpResult|GpResultSummary|DictionarySecurityCore|Inventory are special; others are engine-projected views. Possible values: None, Raw, GpResult, GpResultSummary, DictionarySecurityCore, DictionaryNetworkCore, Inventory, Settings, Unknown, Coverage, Summary, Policies, Applied, Denied, Trace, Sites, Preferences, PreferencesTrace, PreferencesPrecedence, Audit, Rights, Certificates, Software, FolderRedirection, Scripts, WindowsUpdate, Defender, Firewall, FirewallDetails, FirewallRules, TimeService, AppLocker, AppLockerRules, DnsClient, Health, Permissions, LinkHealth
- Possible values:
Raw,GpResult,GpResultSummary,DictionarySecurityCore,DictionaryNetworkCore,Inventory,Settings,Unknown,Coverage,Summary,Policies,Applied,Denied,Trace,Sites,Preferences,PreferencesTrace,PreferencesPrecedence,Audit,Rights,Certificates,Software,FolderRedirection,Scripts,WindowsUpdate,Defender,Firewall,FirewallDetails,FirewallRules,TimeService,AppLocker,AppLockerRules,DnsClient,Health,Permissions,LinkHealth
Outputs
ADPlayground.Gpo.GpoInventoryRollupReport, ADPlayground.Gpo.GpoResultPairReport, ADPlayground.Gpo.GpoResultReport
Get-ADXGpoResult -View <Raw> [-Action <string>] [-AdmxDirectory <string>] [-Category <string>] [-DomainFilter <string>] [-EvaluateApplicability] [-Forest <string>] [-IncludeHealth] [-IncludeSites] [-Key <string>] [-Language <string>] [-MatchedOnly] [-Minimal] [-ShowApplicabilityTrace] [-Sites <string[]>] [-SupportedOnly] [<CommonParameters>]Parameter set:
By DomainFilter + ForestParameters
- View AdxGpoResultView
- Optional view selector; engine enum living in ADPlayground. Raw|GpResult|GpResultSummary|DictionarySecurityCore|Inventory are special; others are engine-projected views. Possible values: None, Raw, GpResult, GpResultSummary, DictionarySecurityCore, DictionaryNetworkCore, Inventory, Settings, Unknown, Coverage, Summary, Policies, Applied, Denied, Trace, Sites, Preferences, PreferencesTrace, PreferencesPrecedence, Audit, Rights, Certificates, Software, FolderRedirection, Scripts, WindowsUpdate, Defender, Firewall, FirewallDetails, FirewallRules, TimeService, AppLocker, AppLockerRules, DnsClient, Health, Permissions, LinkHealth
- Possible values:
Raw,GpResult,GpResultSummary,DictionarySecurityCore,DictionaryNetworkCore,Inventory,Settings,Unknown,Coverage,Summary,Policies,Applied,Denied,Trace,Sites,Preferences,PreferencesTrace,PreferencesPrecedence,Audit,Rights,Certificates,Software,FolderRedirection,Scripts,WindowsUpdate,Defender,Firewall,FirewallDetails,FirewallRules,TimeService,AppLocker,AppLockerRules,DnsClient,Health,Permissions,LinkHealth - Action string
- Optional wildcard to filter PreferencesTrace by Action (Create/Update/Replace/Delete).
- AdmxDirectory string
- Optional ADMX/ADML directory; auto-resolved when omitted.
- Category string
- Wildcard filter for category/policy display/name (used by engine projector).
- DomainFilter string
- Optional domain filter for Inventory view (exact or wildcard).
- EvaluateApplicability SwitchParameter
- Evaluate security filtering and WMI filtering (Applicability).
- Forest string
- Forest DNS name for Inventory view; when omitted, the current forest is used.
- IncludeHealth SwitchParameter
- Include health signals for Inventory view (version mismatch and broken WMI, LDAP+SYSVOL only).
- IncludeSites SwitchParameter
- Include site‑linked GPOs in the evaluation.
- Key string
- Optional wildcard to filter PreferencesTrace by Key.
- Language string
- Preferred ADML language (e.g., en-US).
- MatchedOnly SwitchParameter
- When set with View=PreferencesTrace, returns only items where targeting matched.
- Minimal SwitchParameter
- Emit compact rows for some views (engine projector honors this).
- ShowApplicabilityTrace SwitchParameter
- Include applicability trace in the output (decision sources and reasons).
- Sites string[]
- Optional list of site names to consider when -IncludeSites is set.
- SupportedOnly SwitchParameter
- Return only policies marked as Supported on the target OS.
Outputs
ADPlayground.Gpo.GpoInventoryRollupReport, ADPlayground.Gpo.GpoResultPairReport, ADPlayground.Gpo.GpoResultReport