< Back
Get-ePoGroupSystem
Post
NAME Get-ePoGroupSystem
SYNOPSIS
Finds a system or systems in an ePoGroup using the ePo API.
SYNTAX
Get-ePoGroupSystem [-GroupID] <String[]> [-Recurse] [-WhatIf] [-Confirm] [<CommonParameters>]
DESCRIPTION
Sends the command specified to the McAfee EPO server. Connect-ePoServer has to be run first,
as this function uses the epoServer global variable created by that functions connection to the server. Uses the
Invoke-ePoCommand
PARAMETERS
-GroupID <String[]>
The Id of the group to search within. Id number can be obtained by using Get-ePoGroup
Required? true
Position? 1
Default value
Accept pipeline input? true (ByValue, ByPropertyName)
Accept wildcard characters? false
-Recurse [<SwitchParameter>]
A switch to search subgroups as well. Defaults to false. True needs to be inputted in lowercase like 'true'
The case sensitivity is part of the ePo API.
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-WhatIf [<SwitchParameter>]
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Confirm [<SwitchParameter>]
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
OUTPUTS
NOTES
Logic added to get disk percent free space as property on object returned.
Added support for GroupId parameter to take an array of strings
Added support for Whatif
-------------------------- EXAMPLE 1 --------------------------
PS C:\\>$GroupPCs = Get-ePoGroupSystem -GroupId "519"
Retruns the output of the epogroup.findSystems API command for computers under GroupId number 519.
-------------------------- EXAMPLE 2 --------------------------
PS C:\\>$FoundSystems = Get-ePoGroupSystem -GroupId "519" -Recurse
Returns an object of the results of the systems in the Group with an ID of 519 including paths below the main one.
-------------------------- EXAMPLE 3 --------------------------
PS C:\\>$FoundSystems = Get-ePoGroup -Filter "Admin" | Get-ePoGroupSystem
This example first gets the GroupID using Get-ePGroup with a Filter for the word Admin and then pipes that GroupID
to find all of the computer systems under that group.
RELATED LINKS
SYNOPSIS
Finds a system or systems in an ePoGroup using the ePo API.
SYNTAX
Get-ePoGroupSystem [-GroupID] <String[]> [-Recurse] [-WhatIf] [-Confirm] [<CommonParameters>]
DESCRIPTION
Sends the command specified to the McAfee EPO server. Connect-ePoServer has to be run first,
as this function uses the epoServer global variable created by that functions connection to the server. Uses the
Invoke-ePoCommand
PARAMETERS
-GroupID <String[]>
The Id of the group to search within. Id number can be obtained by using Get-ePoGroup
Required? true
Position? 1
Default value
Accept pipeline input? true (ByValue, ByPropertyName)
Accept wildcard characters? false
-Recurse [<SwitchParameter>]
A switch to search subgroups as well. Defaults to false. True needs to be inputted in lowercase like 'true'
The case sensitivity is part of the ePo API.
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-WhatIf [<SwitchParameter>]
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Confirm [<SwitchParameter>]
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
OUTPUTS
NOTES
Logic added to get disk percent free space as property on object returned.
Added support for GroupId parameter to take an array of strings
Added support for Whatif
-------------------------- EXAMPLE 1 --------------------------
PS C:\\>$GroupPCs = Get-ePoGroupSystem -GroupId "519"
Retruns the output of the epogroup.findSystems API command for computers under GroupId number 519.
-------------------------- EXAMPLE 2 --------------------------
PS C:\\>$FoundSystems = Get-ePoGroupSystem -GroupId "519" -Recurse
Returns an object of the results of the systems in the Group with an ID of 519 including paths below the main one.
-------------------------- EXAMPLE 3 --------------------------
PS C:\\>$FoundSystems = Get-ePoGroup -Filter "Admin" | Get-ePoGroupSystem
This example first gets the GroupID using Get-ePGroup with a Filter for the word Admin and then pipes that GroupID
to find all of the computer systems under that group.
RELATED LINKS