# Get-BluGenieADGroupMembers Get-BluGenieADGroupMembers ### SYNOPSIS Query Active Directory via LDAP without the need for RSAT to be installed. ### SYNTAX ``` Get-BluGenieADGroupMembers [[-GroupName] ] [[-Domain] ] [-FullDetails] [-UseCache] [[-CachePath] ] [-Walkthrough] [-ReturnObject] [-OutUnEscapedJSON] [-OutYaml] [[-FormatView] ] [] ``` ### DESCRIPTION Query Active Directory via LDAP without the need for RSAT to be installed. ### EXAMPLES #### EXAMPLE 1 ``` Command: $ConsoleSystems = Get-BGADGroupMembers -GroupName S_Wrk_Posh3PlusLabSystems -ReturnObject ``` ``` Description: Use this command to Query an AD Group and assign them to the BluGenie Console Systems variable Notes: ``` #### EXAMPLE 2 ``` Command: Get-BGADGroupMembers -GroupName S_Wrk_Posh3PlusLabSystems -ReturnObject ``` ``` Description: Use the command to display a list of computers from an AD Group Notes: ``` #### EXAMPLE 3 ``` Command: ADGM -GroupName S_Wrk_Posh3PlusLabSystems -UseCache ``` ``` Description: Use this Short-Hand Alias to create a text file with a list of computers from an AD Group Notes: ``` #### EXAMPLE 4 ``` Command: Get-BGADGroupMembers -GroupName S_Wrk_Posh3PlusLabSystems -UseCache -FullDetails ``` ``` Description: Use this command to create a csv file with a list of computers and their AD properties (Name,SAMAccountname,DisplayName,Description,Path) Notes: ``` #### EXAMPLE 5 ``` Command: Get-BGADGroupMembers -GroupName S_Wrk_Posh3PlusLabSystems -OutYaml -Verbose ``` ``` Description: Use this command to view a full detailed yaml report on the members of the AD Group and function details Notes: ``` #### EXAMPLE 6 ``` Command: Get-BGADGroupMembers -GroupName S_Wrk_Posh3PlusLabSystems -UseCache -CachePath .\Collections\S_Wrk_Posh3PlusLabSystems.txt ``` ``` Description: Use this command to save the AD Group members to a specific text file. Notes: By default the Cache location is %temp% with a BGSys_.txt file name. ``` #### EXAMPLE 7 ``` Command: Get-BluGenieADGroupMembers -Help ``` ``` Description: Call Help Information Notes: If Help / WalkThrough is setup as a parameter, this script will be called to setup the Dynamic Help Menu if not the normal Get-Help will be called with the -Full parameter ``` #### EXAMPLE 8 ``` Command: Get-BluGenieADGroupMembers -WalkThrough ``` ``` Description: Call Help Information [2] Notes: If Help / WalkThrough is setup as a parameter, this script will be called to setup the Dynamic Help Menu if not the normal Get-Help will be called with the -Full parameter ``` #### EXAMPLE 9 ``` Command: Get-BGADGroupMembers -OutUnEscapedJSON ``` ``` Description: Return a detailed function report in an UnEscaped JSON format Notes: The OutUnEscapedJSON is used to Beautify the JSON return and not Escape any Characters. Normal return data is a Hash Table. ``` #### EXAMPLE 10 ``` Command: Get-BGADGroupMembers -OutYaml ``` ``` Description: Return a detailed function report in YAML format Notes: The OutUnEscapedJSON is used to Beautify the JSON return and not Escape any Characters. Normal return data is a Hash Table. ``` #### EXAMPLE 11 ``` Command: Get-BGADGroupMembers -ReturnObject ``` ``` Description: Return Output as a Object Notes: The ReturnObject is used to return a PowerShell Object. Normal return data is a Hash Table. This parameter is also used with the FormatView ``` #### EXAMPLE 12 ``` Command: Get-BluGenieADGroupMembers -ReturnObject -FormatView Yaml ``` ``` Description: Output PSObject information in Yaml format Notes: Current formats supported by default are ('Table','Custom','CustomModified','None','JSON','OutUnEscapedJSON','CSV', 'Yaml') Default is set to (None) and normal PSObject. ``` ### PARAMETERS #### GroupName ``` -GroupName Description: The name of the Group you are going to do a member lookup on Notes: This is Mandatory. If this option is left blank the return is Null Alias: GN ValidateSet: Required? false Position? 1 Default value Accept pipeline input? false Accept wildcard characters? false ``` #### Domain ``` -Domain Description: The name of the Domain in which you are looking for the Group and Member information Notes: The default domain name is pulled from the Registry. If this option is not set or the domain name is not found in the registry the return is Null Alias: DO ValidateSet: Required? false Position? 2 Default value $(Get-ItemProperty -Path 'HKLM:\SOFTWARE\Microsoft\Windows\CurrentVersion\Group Policy\History' -Name 'MachineDomain' -ErrorAction SilentlyContinue | Select-Object -ExpandProperty 'MachineDomain') Accept pipeline input? false Accept wildcard characters? false ``` #### FullDetails ``` -FullDetails [] Description: Return a PSObject with the following values (Name, SAMAccountname, DisplayName, Description and the Path) Notes: The default return is a list of Names (ONLY) Alias: FD ValidateSet: Required? false Position? named Default value False Accept pipeline input? false Accept wildcard characters? false ``` #### UseCache ``` -UseCache [] Description: Cache found objects to disk Notes: By default the Cache location is %SystemDrive%\Windows\Temp Alias: UC ValidateSet: Required? false Position? named Default value False Accept pipeline input? false Accept wildcard characters? false ``` #### CachePath ``` -CachePath Description: Path to store the Cache information Notes: By default the Cache location is %temp% with a BGSys_.txt file name. Example: C:\Users\ADMINI~1\AppData\Local\Temp\BGSys_46964-41870-29555-35418-93311.txt Alias: CP ValidateSet: Required? false Position? 3 Default value $('{0}\BGSys_{1}.txt' -f $env:temp, $(New-BluGenieUID)) Accept pipeline input? false Accept wildcard characters? false ``` #### Walkthrough ``` -Walkthrough [] Description: Start the dynamic help menu system to help walk through the current command and all of the parameters Notes: Alias: Help ValidateSet: Required? false Position? named Default value False Accept pipeline input? false Accept wildcard characters? false ``` #### ReturnObject ``` -ReturnObject [] Description: Return information as an Object Notes: By default the data is returned as a Hash Table Alias: ValidateSet: Required? false Position? named Default value False Accept pipeline input? false Accept wildcard characters? false ``` #### OutUnEscapedJSON ``` -OutUnEscapedJSON [] Description: Remove UnEsacped Char from the JSON information. Notes: This will beautify json and clean up the formatting. Alias: ValidateSet: Required? false Position? named Default value False Accept pipeline input? false Accept wildcard characters? false ``` #### OutYaml ``` -OutYaml [] Description: Return detailed information in Yaml Format Notes: Only supported in Posh 3.0 and above Alias: ValidateSet: Required? false Position? named Default value False Accept pipeline input? false Accept wildcard characters? false ``` #### FormatView ``` -FormatView Description: Automatically format the Return Object Notes: Yaml is only supported in Posh 3.0 and above Alias: ValidateSet: 'Table','Custom','CustomModified','None','JSON','OutUnEscapedJSON','CSV', 'Yaml' Required? false Position? 4 Default value None Accept pipeline input? false Accept wildcard characters? false ``` #### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about\_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). --- # Agent Instructions: Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter: ``` GET https://manuals.blusapphire.io/blugenie/full-function-list/get-blugenieadgroupmembers.md?ask= ``` The question should be specific, self-contained, and written in natural language. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.