API Reference
Command
Get-ADXGroup
Retrieves Active Directory groups in list mode or a single group by identity.
Examples
Example 1: Default identity mode with a single expected match
Get-ADXGroup -Identity 'Domain Admins' -Domain 'contoso.com'
Example 2: Return all matches across queried domains
Get-ADXGroup -Identity 'Helpdesk' -Domain 'contoso.com','fabrikam.com' -AllMatches
Example 3: Return all matches across forest domains
Get-ADXGroup -Identity 'Helpdesk' -AllMatches
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-ADXGroup -Identity <string> [-AllMatches] [-Domain <string[]>] [-IncludeMembers] [-IncludeTrustedDomains] [-MemberRecursionDepth <int>] [-Property <string[]>] [-RecursiveMembers] [-Scope <CurrentDomain|Forest|TrustedForests|ExplicitDomains>] [<CommonParameters>]Parameter set:
By IdentityParameters
- Identity string
- Gets or sets group identity (sAMAccountName, DN, mail, or name) for single-object mode.
- AllMatches SwitchParameter
- Gets or sets whether identity mode should return all matches across queried domains. By default (switch not set), identity mode expects a single match and throws on ambiguity.
- Domain string[]
- Gets or sets domain DNS names. In list mode defaults to current domain.
- IncludeMembers SwitchParameter
- Gets or sets whether to include direct group memberships in identity mode.
- IncludeTrustedDomains SwitchParameter
- Includes trusted domains when using forest-based scopes.
- MemberRecursionDepth int
- Gets or sets the maximum recursion depth for recursive member resolution in identity mode.
- Property string[]
- Gets or sets optional additional LDAP attributes to return in identity mode.
- RecursiveMembers SwitchParameter
- Gets or sets whether to resolve recursive members in identity mode.
- Scope DirectoryScenarioScope
- Default scope used when -Domain is not provided. Possible values: CurrentDomain, Forest, TrustedForests, ExplicitDomains
- Possible values:
CurrentDomain,Forest,TrustedForests,ExplicitDomains
Outputs
ADPlayground.DirectoryGraphSnapshot, ADPlayground.DirectoryGroupMembersSnapshot, ADPlayground.DirectoryObjectSnapshot, ADPlayground.GroupInfo
Get-ADXGroup [-AllowCrossDomain <bool>] [-AllowCrossForest <bool>] [-CacheDurationSeconds <int>] [-Domain <string[]>] [-EnableGraphSnapshotPersistence] [-Filter <string>] [-First <int>] [-GraphSnapshotDomainController <string>] [-GraphSnapshotMaxAgeSeconds <int>] [-GraphSnapshotPath <string>] [-GraphSnapshotRefreshOnUsnChange <bool>] [-IncludeMemberCount] [-IncludeNestingSummary] [-IncludeTrustedDomains] [-LDAPFilter <string>] [-MaxParallel <int>] [-MaxTraversalDepth <int>] [-PageSize <int>] [-PropertySet <Basic|Full>] [-Scope <CurrentDomain|Forest|TrustedForests|ExplicitDomains>] [-SearchBase <string>] [-Skip <int>] [-TrustMode <Default|Strict|BestEffort>] [-UseCache] [-View <Default|Summary|Graph>] [<CommonParameters>]Parameter set:
By AllowCrossDomain + AllowCrossForestParameters
- AllowCrossDomain bool
- Allows cross-domain entries in -View Graph output (default: $true).
- AllowCrossForest bool
- Allows cross-forest entries in -View Graph output (default: $true).
- CacheDurationSeconds int
- Cache duration in seconds when -UseCache is set (default 120).
- Domain string[]
- Gets or sets domain DNS names. In list mode defaults to current domain.
- EnableGraphSnapshotPersistence SwitchParameter
- Enables persisted graph snapshot reuse for -View Graph.
- Filter string
- PowerShell-style filter pattern (simple) in list mode.
- First int
- Limits the number of returned rows after -Skip in list mode.
- GraphSnapshotDomainController string
- Optional domain controller hint used for RootDSE USN checks in -View Graph mode.
- GraphSnapshotMaxAgeSeconds int
- Maximum persisted graph snapshot age in seconds for -View Graph (default 600).
- GraphSnapshotPath string
- Optional persisted graph snapshot file path for -View Graph.
- GraphSnapshotRefreshOnUsnChange bool
- When $true, refreshes persisted snapshots on directory USN changes in -View Graph mode.
- IncludeMemberCount SwitchParameter
- Include direct member count for each group in list mode.
- IncludeNestingSummary SwitchParameter
- Compute nested membership summary in list mode.
- IncludeTrustedDomains SwitchParameter
- Includes trusted domains when using forest-based scopes.
- LDAPFilter string
- Raw LDAP filter in list mode; takes precedence over -Filter.
- MaxParallel int
- Maximum parallelism when computing -IncludeNestingSummary (default 3).
- MaxTraversalDepth int
- Maximum traversal depth for -View Graph; when omitted, service defaults are used.
- PageSize int
- LDAP page size in list mode (default 1000).
- PropertySet GroupProperties
- Property set for groups in list mode. Possible values: Basic, Full
- Possible values:
Basic,Full - Scope DirectoryScenarioScope
- Default scope used when -Domain is not provided. Possible values: CurrentDomain, Forest, TrustedForests, ExplicitDomains
- Possible values:
CurrentDomain,Forest,TrustedForests,ExplicitDomains - SearchBase string
- Search base DN in list mode.
- Skip int
- Skips the specified number of rows after deterministic ordering in list mode.
- TrustMode DirectoryGraphTrustMode
- Trust posture for -View Graph partition handling. Possible values: Default, Strict, BestEffort
- Possible values:
Default,Strict,BestEffort - UseCache SwitchParameter
- Enable in-memory caching in list mode.
- View AdxGroupsView
- Output view in list mode: Default, Summary, or Graph. Possible values: Default, Summary, Graph
- Possible values:
Default,Summary,Graph
Outputs
ADPlayground.DirectoryGraphSnapshot, ADPlayground.DirectoryGroupMembersSnapshot, ADPlayground.DirectoryObjectSnapshot, ADPlayground.GroupInfo