Get-JCPolicyTargetGroup

NAME Get-JCPolicyTargetGroup



SYNOPSIS

Returns all bound groups associated with a JumpCloud Policy within a JumpCloud tenant.





SYNTAX

Get-JCPolicyTargetGroup [-PolicyName] <System.String> [-ByName] [<CommonParameters>]



Get-JCPolicyTargetGroup [-PolicyID] <System.String> [<CommonParameters>]





DESCRIPTION

The Get-JCPolicyTargetGroup returns information about all bound groups associated with a JumpCloud Policy within a

JumpCloud tenant.





PARAMETERS

-ByName <System.Management.Automation.SwitchParameter>

Use the -ByName parameter when you want to query a specific policy. The -ByName SwitchParameter will set the

ParameterSet to 'ByName' which queries one JumpCloud policy at a time.



Required? false

Position? named

Default value False

Accept pipeline input? False

Accept wildcard characters? false



-PolicyID <System.String>

The PolicyID of the JumpCloud policy you wish to query.



Required? true

Position? 0

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-PolicyName <System.String>

The Name of the JumpCloud policy you wish to query.



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-JCPolicyTargetGroup -PolicyId 123456789



Returns the bound groups associated for a policy with the id of 123456789.

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



PS C:\\> Get-JCPolicyTargetGroup -PolicyName 'HelloWorld'



Returns the bound groups associated for a policy with the name of HelloWorld.

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



PS C:\\> Get-JCPolicy | Get-JCPolicyTargetGroup



Returns all policies within a JumpCloud tenant and the bound groups associated to those policies.



RELATED LINKS

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