< Back
Add-JCSystemGroupMember
Post
NAME Add-JCSystemGroupMember
SYNOPSIS
Adds a JumpCloud System to a JumpCloud System Group
SYNTAX
Add-JCSystemGroupMember [[-GroupName] <System.String>] [-ByID] [-GroupID <System.String>] -SystemID
<System.String> [<CommonParameters>]
Add-JCSystemGroupMember [-GroupName] <System.String> -SystemID <System.String> [<CommonParameters>]
DESCRIPTION
The Add-JCSystemGroupMember function is used to add a JumpCloud System to a JumpCloud System Group. The new System
Group member must be added by the SystemID parameter.
PARAMETERS
-ByID <System.Management.Automation.SwitchParameter>
Use the -ByID parameter when the GroupID and SystemID are both being passed over the pipeline to the
Add-JCSystemGroupMember function. The -ByID SwitchParameter will set the ParameterSet to "ByID" which will
increase the function speed and performance.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-GroupID <System.String>
The GroupID is used in the ParameterSet 'ByID'. The GroupID for a System Group can be found by running the
command:
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-GroupName <System.String>
The name of the JumpCloud System Group that you want to add the System to.
Required? true
Position? 0
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-SystemID <System.String>
The _id of the System which you want to add to the System Group.
To find a JumpCloud SystemID run the command:
PS C:\\> Get-JCSystem | Select hostname, _id
The SystemID will be the 24 character string populated for the _id field.
SystemID has an Alias of _id. This means you can leverage the PowerShell pipeline to populate this field
automatically using the Get-JCSystem function before calling Add-JCSystemGroupMember. This is shown in
EXAMPLES 2, 3, and 4.
Required? true
Position? named
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:\\> Add-JCSystemGroupMember -GroupName 'Windows Systems' -SystemID '59dad305383roc7k369sf7s2'
Adds a System with SystemID '59dad305383roc7k369sf7s2' to the System Group 'Windows Systems'
-------------------------- Example 2 --------------------------
PS C:\\> Get-JCSystem | Where-Object os -Like *Mac* | Add-JCSystemGroupMember -GroupName 'Mac Systems'
Adds all Systems with an operating system like 'Mac' to the System Group 'Mac Systems'
-------------------------- Example 3 --------------------------
Get-JCSystem | Where-Object active -EQ $true | Add-JCSystemGroupMember -GroupName 'Active Systems'
Adds all active systems to the System Group 'Active Systems'
-------------------------- Example 4 --------------------------
Get-JCSystem | Where-Object {$_.active -EQ $true -and $_.os -like '*Mac*'} | Add-JCSystemGroupMember 'Active Mac
Systems'
Adds all active systems with an operating system like 'Mac' to the System Group 'Active Mac Systems'
RELATED LINKS
Online Version: https://github.com/TheJumpCloud/support ... roupMember
SYNOPSIS
Adds a JumpCloud System to a JumpCloud System Group
SYNTAX
Add-JCSystemGroupMember [[-GroupName] <System.String>] [-ByID] [-GroupID <System.String>] -SystemID
<System.String> [<CommonParameters>]
Add-JCSystemGroupMember [-GroupName] <System.String> -SystemID <System.String> [<CommonParameters>]
DESCRIPTION
The Add-JCSystemGroupMember function is used to add a JumpCloud System to a JumpCloud System Group. The new System
Group member must be added by the SystemID parameter.
PARAMETERS
-ByID <System.Management.Automation.SwitchParameter>
Use the -ByID parameter when the GroupID and SystemID are both being passed over the pipeline to the
Add-JCSystemGroupMember function. The -ByID SwitchParameter will set the ParameterSet to "ByID" which will
increase the function speed and performance.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-GroupID <System.String>
The GroupID is used in the ParameterSet 'ByID'. The GroupID for a System Group can be found by running the
command:
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-GroupName <System.String>
The name of the JumpCloud System Group that you want to add the System to.
Required? true
Position? 0
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-SystemID <System.String>
The _id of the System which you want to add to the System Group.
To find a JumpCloud SystemID run the command:
PS C:\\> Get-JCSystem | Select hostname, _id
The SystemID will be the 24 character string populated for the _id field.
SystemID has an Alias of _id. This means you can leverage the PowerShell pipeline to populate this field
automatically using the Get-JCSystem function before calling Add-JCSystemGroupMember. This is shown in
EXAMPLES 2, 3, and 4.
Required? true
Position? named
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:\\> Add-JCSystemGroupMember -GroupName 'Windows Systems' -SystemID '59dad305383roc7k369sf7s2'
Adds a System with SystemID '59dad305383roc7k369sf7s2' to the System Group 'Windows Systems'
-------------------------- Example 2 --------------------------
PS C:\\> Get-JCSystem | Where-Object os -Like *Mac* | Add-JCSystemGroupMember -GroupName 'Mac Systems'
Adds all Systems with an operating system like 'Mac' to the System Group 'Mac Systems'
-------------------------- Example 3 --------------------------
Get-JCSystem | Where-Object active -EQ $true | Add-JCSystemGroupMember -GroupName 'Active Systems'
Adds all active systems to the System Group 'Active Systems'
-------------------------- Example 4 --------------------------
Get-JCSystem | Where-Object {$_.active -EQ $true -and $_.os -like '*Mac*'} | Add-JCSystemGroupMember 'Active Mac
Systems'
Adds all active systems with an operating system like 'Mac' to the System Group 'Active Mac Systems'
RELATED LINKS
Online Version: https://github.com/TheJumpCloud/support ... roupMember