Get-JCGroup

NAME Get-JCGroup



SYNOPSIS

Returns all JumpCloud System and User Groups.





SYNTAX

Get-JCGroup [[-Type] {User | System}] [-Name <System.String>] [<CommonParameters>]





DESCRIPTION

The Get-JCGroup function by default will return all JumpCloud System and User groups. By using the -Type Parameter

you can choose to return either System or User groups.





PARAMETERS

-Name <System.String>

Enter the group name



Required? false

Position? named

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-Type <System.String>

The type of JumpCloud group you want to return. Note there are only two options - User and System.



Required? false

Position? 0

Default value None

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

System.String







OUTPUTS

System.Object







NOTES









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



PS C:\\> Get-JCGroup



Returns all JumpCloud User and System groups

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



PS C:\\> Get-JCGroup -Type User



Returns all JumpCloud User groups

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



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



Returns all JumpCloud System groups

-------------------------- Example 4 --------------------------



PS C:\\> Get-JCGroup -Type User -Name 'The Band'



Returns the JumpCloud user group 'The Band' and the posixGroups information descripting this group



RELATED LINKS

Online Version: https://github.com/TheJumpCloud/support ... et-JCGroup