Get-SCSMGroup

Get-SCSMGroup

Gets groups from Service Manager.

Syntax

Parameter Set: Empty
Get-SCSMGroup [-ComputerName <String[]> ] [-Credential <PSCredential> ] [-SCSession <Connection[]> ] [ <CommonParameters>]

Parameter Set: FromGroupDisplayName
Get-SCSMGroup [-DisplayName] <String[]> [-ComputerName <String[]> ] [-Credential <PSCredential> ] [-SCSession <Connection[]> ] [ <CommonParameters>]

Parameter Set: FromGroupGuid
Get-SCSMGroup [-Id] <Guid[]> [-ComputerName <String[]> ] [-Credential <PSCredential> ] [-SCSession <Connection[]> ] [ <CommonParameters>]

Detailed Description

The Get-SCSMGroup cmdlet retrieves groups from Service Manager. The output of this cmdlet may be used by other cmdlets, such as the New-SCSMUserRole cmdlet.

Parameters

-ComputerName<String[]>

Specifies a computer with which to establish a connection. The computer must be running the System Center Data Access service. The default value is the computer for the current management group connection.

Valid formats include a NetBIOS name, an IP address, or a fully qualified domain name (FQDN). To specify the local computer, type the computer name, "localhost", or a dot (.).

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	true (ByValue)
Accept Wildcard Characters?	false

-Credential<PSCredential>

Specifies a user account under which the management group connection will run. The account must have access to the server that is specified in the ComputerName parameter, if the server is specified. The default value is the current user.

You can enter a PSCredential object that is returned by the Get-Credential cmdlet.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	true (ByValue)
Accept Wildcard Characters?	false

-DisplayName<String[]>

Specifies the display name of the groups to retrieve.

Aliases	none
Required?	true
Position?	1
Default Value	none
Accept Pipeline Input?	true (ByValue)
Accept Wildcard Characters?	true

-Id<Guid[]>

Specifies the ID of the groups to retrieve. This may be a GUID or a string that will be converted to a GUID.

Aliases	none
Required?	true
Position?	1
Default Value	none
Accept Pipeline Input?	true (ByValue)
Accept Wildcard Characters?	false

-SCSession<Connection[]>

Specifies a connection to a management server. The default value is the current management group connection.

You can enter a management group connection object that is returned by the Get-SCManagementGroupConnection cmdlet.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	true (ByValue)
Accept Wildcard Characters?	false

<CommonParameters>

This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see    about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216).

Inputs

The input type is the type of the objects that you can pipe to the cmdlet.

• System.Guid

  You can pipe a group GUID to the Id parameter of the Get-SCSMGroup cmdlet.

• System.String

  You can pipe a name of a group to the DisplayName parameter of the Get-SCSMGroup cmdlet.

Outputs

The output type is the type of the objects that the cmdlet emits.

• Microsoft.EnterpriseManagement.Common.EnterpriseManagementObject

  The output of this cmdlets is a group object.

Examples

Example 1: Get groups from Service Manager

This command retrieves groups from Service Manager.

PS C:\>Get-SCSMGroup

Example 2: Get groups and display their details in a table

This command retrieves groups and then displays their FullName and DisplayName properties.

PS C:\>Get-SCSMGroup |Format-Table fullname,displayname

Example 3: Get the details of a group

This command retrieves the All Windows Computers group.

PS C:\>Get-SCSMGroup -DisplayName "All Windows Computers"

Example 4: Get a group and display its properties

This command retrieves the All Windows Computers group and then displays all of its properties.

PS C:\>Get-SCSMGroup -DisplayName "All Windows Computers"|Format-List