< Back

Add-JCCommandTarget

Thu Jan 16, 2020 8:43 am

NAME Add-JCCommandTarget



SYNOPSIS

Associates a JumpCloud system or a JumpCloud system group with a JumpCloud command





SYNTAX

Add-JCCommandTarget [-CommandID] <System.String> [-GroupID] <System.Object> [<CommonParameters>]



Add-JCCommandTarget [-CommandID] <System.String> [-GroupName] <System.Object> [<CommonParameters>]



Add-JCCommandTarget [-CommandID] <System.String> [-SystemID] <System.Object> [<CommonParameters>]





DESCRIPTION

The Add-JCCommandTarget function allows you to add JumpCloud systems or JumpCloud system groups to the target list

of a specific JumpCloud command. Group associations can be made by system group name or system group ID system

associations can only be made using the SystemID. When JumpCloud commands are run they target all the systems on

their target list.





PARAMETERS

-CommandID <System.String>

The id value of the JumpCloud command. Use the command "Get-JCCommand | Select-Object _id, name" to find the

"_id" value for all the JumpCloud commands in your tenant.



Required? true

Position? 0

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-GroupID <System.Object>

The id value of a JumpCloud system group



Required? true

Position? 1

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-GroupName <System.Object>

The name of the JumpCloud system group. If the name includes a space enter the name within quotes. Example:

-GroupName "The Space"



Required? true

Position? 1

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-SystemID <System.Object>

The _id of a JumpCloud system. To find the _id of all JumpCloud systems within your tenant run "Get-JCSystem |

select _id, hostname"



Required? true

Position? 1

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





System.Object







OUTPUTS

System.Object







NOTES









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



Add-JCCommandTarget -CommandID 5b99777710a3690ssisr3a1w -SystemID 5l0o2fu426041i79st3c35



Adds the JumpCloud system with System ID '5l0o2fu426041i79st3c35' to the target list for the JumpCloud command

with command ID '5b99777710a3690ssisr3a1w'

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



Add-JCCommandTarget -CommandID 5b99777710a3690ssisr3a1w -GroupName WindowsMachines



Adds the JumpCloud system group 'WindowsMachines' and the systems within this group to the target list for the

JumpCloud command with command ID '5b99777710a3690ssisr3a1w'

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



Add-JCCommandTarget -CommandID 5b99777710a3690ssisr3a1w -GroupID 5j03458a232z115210z66913



Adds the JumpCloud system group with the GroupID '5j03458a232z115210z66913' and the systems within this group to

the target list for the JumpCloud command with command ID '5b99777710a3690ssisr3a1w'



RELATED LINKS

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