Skip to content

Commit

Permalink
Browse files Browse the repository at this point in the history
  • Loading branch information
CircleCI authored and CircleCI committed Apr 8, 2022
1 parent c2e3cf0 commit af72f7c
Show file tree
Hide file tree
Showing 68 changed files with 11,189 additions and 0 deletions.
1 change: 1 addition & 0 deletions PowerShell/Deploy/support.wiki
Submodule support.wiki added at b358d5
181 changes: 181 additions & 0 deletions PowerShell/support.wiki/Add-JCAssociation.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,181 @@
# Add-JCAssociation

## SYNOPSIS
Create an association between two object within the JumpCloud console.

## SYNTAX

### ById (Default)
```
Add-JCAssociation [-Type] <String> [-Force] [-Id] <String[]> [[-TargetType] <String[]>] [[-TargetId] <String>]
[[-TargetName] <String>] [[-Attributes] <PSObject>] [<CommonParameters>]
```

### ByName
```
Add-JCAssociation [-Type] <String> [-Force] [-Name] <String[]> [[-TargetType] <String[]>]
[[-TargetId] <String>] [[-TargetName] <String>] [[-Attributes] <PSObject>] [<CommonParameters>]
```

## DESCRIPTION
The Add-JCAssociation function allows you to create associations of a specific object to a target object.

## EXAMPLES

### Example 1
```powershell
PS C:\> Add-JCAssociation -Type:('radiusservers') -Id:('5c5c371704c4b477964ab4fa') -TargetType:('user_group') -TargetId:('59f20255c9118021fa01b80f')
```

Create an association between the radius server "5c5c371704c4b477964ab4fa" and the user group "59f20255c9118021fa01b80f".

### Example 2
```powershell
PS C:\> Add-JCAssociation -Type:('radiusservers') -Name:('RadiusServer1') -TargetType:('user_group') -TargetName:('All Users')
```

Create an association between the radius server "RadiusServer1" and the user group "All Users".

## PARAMETERS

### -Attributes
Add attributes that define the association such as if they are an admin.

```yaml
Type: System.Management.Automation.PSObject
Parameter Sets: (All)
Aliases: compiledAttributes

Required: False
Position: 12
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
```
### -Force
Bypass user prompts and dynamic ValidateSet.
```yaml
Type: System.Management.Automation.SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
```
### -Id
The unique id of the object.
```yaml
Type: System.String[]
Parameter Sets: ById
Aliases: _id

Required: True
Position: 1
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
```
### -Name
The name of the object.
```yaml
Type: System.String[]
Parameter Sets: ByName
Aliases: domain, displayName, username

Required: True
Position: 1
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
```
### -TargetId
The unique id of the target object.
```yaml
Type: System.String
Parameter Sets: (All)
Aliases:

Required: False
Position: 10
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
```
### -TargetName
The name of the target object.
```yaml
Type: System.String
Parameter Sets: (All)
Aliases:

Required: False
Position: 11
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
```
### -TargetType
The type of the target object.
```yaml
Type: System.String[]
Parameter Sets: (All)
Aliases: TargetSingular
Accepted values: user, user_group, system, system_group, policy, command, application, g_suite, ldap_server, office_365, radius_server

Required: False
Position: 2
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
```
### -Type
The type of the object.
```yaml
Type: System.String
Parameter Sets: (All)
Aliases: TypeNameSingular
Accepted values: command, ldap_server, policy, application, radius_server, system_group, system, user_group, user, g_suite, office_365

Required: True
Position: 0
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
```
### CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
## INPUTS
### System.String
### System.Management.Automation.SwitchParameter
### System.String[]
### System.Management.Automation.PSObject
## OUTPUTS
### System.Object
## NOTES
## RELATED LINKS
129 changes: 129 additions & 0 deletions PowerShell/support.wiki/Add-JCCommandTarget.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,129 @@
# Add-JCCommandTarget

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

## SYNTAX

### SystemID (Default)
```
Add-JCCommandTarget [-CommandID] <String> [-SystemID] <Object> [<CommonParameters>]
```

### GroupID
```
Add-JCCommandTarget [-CommandID] <String> [-GroupID] <Object> [<CommonParameters>]
```

### GroupName
```
Add-JCCommandTarget [-CommandID] <String> [-GroupName] <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.

## EXAMPLES

### Example 1
```powershell
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
```powershell
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
```powershell
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'

## PARAMETERS

### -CommandID
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.

```yaml
Type: System.String
Parameter Sets: (All)
Aliases: _id, id

Required: True
Position: 0
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
```
### -GroupID
The id value of a JumpCloud system group
```yaml
Type: System.Object
Parameter Sets: GroupID
Aliases:

Required: True
Position: 1
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
```
### -GroupName
The name of the JumpCloud system group.
If the name includes a space enter the name within quotes.
Example: -GroupName "The Space"
```yaml
Type: System.Object
Parameter Sets: GroupName
Aliases: name

Required: True
Position: 1
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
```
### -SystemID
The _id of a JumpCloud system.
To find the _id of all JumpCloud systems within your tenant run "Get-JCSystem | select _id, hostname"
```yaml
Type: System.Object
Parameter Sets: SystemID
Aliases:

Required: True
Position: 1
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
```
### CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
## INPUTS
### System.String
### System.Object
## OUTPUTS
### System.Object
## NOTES
## RELATED LINKS
Loading

0 comments on commit af72f7c

Please sign in to comment.