Get-SCOMGroup
Gets Operations Manager groups.
Syntax
Empty (Default)
Get-SCOMGroup
[-SCSession <Connection[]>]
[-ComputerName <String[]>]
[-Credential <PSCredential>]
[<CommonParameters>]
FromGroupDisplayName
Get-SCOMGroup
[-DisplayName] <String[]>
[-SCSession <Connection[]>]
[-ComputerName <String[]>]
[-Credential <PSCredential>]
[<CommonParameters>]
FromGroupGuid
Get-SCOMGroup
[-Id] <Guid[]>
[-SCSession <Connection[]>]
[-ComputerName <String[]>]
[-Credential <PSCredential>]
[<CommonParameters>]
Description
The Get-SCOMGroup cmdlet gets System Center - Operations Manager groups. You can specify which groups to get by name or ID.
Because a group object is a type of class instance object, it can be passed to the Instance parameter of another cmdlet, such as the Enable-SCOMDiscovery cmdlet.
By default, this cmdlet uses the active persistent connection to a management group.
Use the SCSession parameter to specify a different persistent connection.
You can create a temporary connection to a management group by using the ComputerName and Credential parameters.
For more information, type Get-Help about_OpsMgr_Connections.
Examples
Example 1: Get groups by using display names
PS C:\>Get-SCOMGroup -DisplayName "*Agent*","*Windows*"
This command gets all groups that have a display name that includes Agent and all groups that have a display name that includes Windows.
Example 2: Get a group by using an ID
PS C:\>Get-SCOMGroup -Id 7413b06b-a95b-4ae3-98f2-dac9ff76dabd
This command gets the group that has an Id of 7413b06b-a95b-4ae3-98f2-dac9ff76dabd.
Parameters
-ComputerName
Specifies an array of names of computers. The cmdlet establishes temporary connections with management groups for these computers. You can use NetBIOS names, IP addresses, or fully qualified domain names (FQDNs). To specify the local computer, type the computer name, localhost, or a dot (.).
The System Center Data Access service must be running on the computer. If you do not specify a computer, the cmdlet uses the computer for the current management group connection.
Parameter properties
| Type: | String[] |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-Credential
Specifies a PSCredential object for the management group connection.
To obtain a PSCredential object, use the Get-Credential cmdlet.
For more information, type Get-Help Get-Credential.
If you specify a computer in the ComputerName parameter, use an account that has access to that computer. The default is the current user.
Parameter properties
| Type: | PSCredential |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-DisplayName
Specifies an array of display names. Values for this parameter depend on which localized management packs you import and the locale of the user that runs Windows PowerShell.
Parameter properties
| Type: | String[] |
| Default value: | None |
| Supports wildcards: | True |
| DontShow: | False |
Parameter sets
FromGroupDisplayName
| Position: | 1 |
| Mandatory: | True |
| Value from pipeline: | True |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-Id
Specifies an array of GUIDs of groups. An SCOMGroup object contains a GUID as its Id property.
Parameter properties
| Type: | Guid[] |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
FromGroupGuid
| Position: | 1 |
| Mandatory: | True |
| Value from pipeline: | True |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-SCSession
Specifies an array of Connection objects. To obtain a Connection object, use the Get-SCOMManagementGroupConnection cmdlet.
Parameter properties
| Type: | Connection[] |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.