API Reference
Class
GpoRemovalPlanner
Builds a set of GPO removal candidates for requested states across one or more domains.
Inheritance
- Object
- GpoRemovalPlanner
Methods
GetCandidates 2 overloads
public static IEnumerable<GpoRemovalCandidate> GetCandidates(IEnumerable<String> domains, IEnumerable<String> states) #Returns:
IEnumerable<GpoRemovalCandidate>Enumerates domains and yields GPOs that match any of the requested states.
Parameters
- domains System.Collections.Generic.IEnumerable{System.String}
- Optional domains. When null/empty, the whole forest is scanned.
- states System.Collections.Generic.IEnumerable{System.String}
- One or more states to match (Unlinked, DisabledLinksOnly, CrossDomainLinks, EmptySettings, EmptyGpo).
public static IReadOnlyList<GpoRemovalCandidate> GetCandidates(IEnumerable<String> domains, IEnumerable<String> states, String sortBy, Boolean descending, Int32 max) #Returns:
IReadOnlyList<GpoRemovalCandidate>Returns candidates with optional sorting and limiting handled in the planner.
Parameters
- domains System.Collections.Generic.IEnumerable{System.String}
- Optional domains. When null/empty, the whole forest is scanned.
- states System.Collections.Generic.IEnumerable{System.String}
- States to match.
- sortBy System.String
- Name | Reasons | Domain | Guid (case-insensitive, default Name)
- descending System.Boolean
- When true, reverse sort order.
- max System.Int32
- Top-N limit; 0 for no limit.