< Back

Get-JCSystemGroupMember

Thu Jan 16, 2020 8:57 am

NAME Get-JCSystemGroupMember



SYNOPSIS

Returns the System Group members of a JumpCloud System Group.





SYNTAX

Get-JCSystemGroupMember -ByID <System.String> [<CommonParameters>]



Get-JCSystemGroupMember [-GroupName] <System.String> [<CommonParameters>]





DESCRIPTION

The Get-JCSystemGroupMember function returns all the System Group members of a JumpCloud System Group.





PARAMETERS

-ByID <System.String>

If searching for a System Group using the GroupID populate the GroupID in the -ByID field.



Required? true

Position? named

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-GroupName <System.String>

The name of the JumpCloud System Group you want to return the members of.



Required? true

Position? 0

Default value None

Accept pipeline input? True (ByPropertyName)

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

System.String







OUTPUTS

System.Object







NOTES









-------------------------- Example 1 --------------------------



PS C:\\> Get-JCSystemGroupMember -GroupName 'OSX Group'



Returns the JumpCloud Systems that are a member of the group 'OSX Group'

-------------------------- Example 2 --------------------------



PS C:\\> Get-JCGroup -Type System | Get-JCSystemGroupMember



Returns all JumpCloud System Groups and their System members.

-------------------------- Example 3 --------------------------



PS C:\\> Get-JCGroup -Type System | Get-JCSystemGroupMember | Where-Object System -EQ 'Server01'



Returns all JumpCloud System Groups that the system with a hostname of 'Server01' is a member of.



RELATED LINKS

Online Version: https://github.com/TheJumpCloud/support ... roupMember