Skip to content

Commit

Permalink
Merge pull request #107 from TheJumpCloud/JumpCloudModule_1.12.0
Browse files Browse the repository at this point in the history
Jump cloud module 1.12.0
  • Loading branch information
scottd3v authored Jun 6, 2019
2 parents 7eb8f19 + db0ea8b commit 52e3447
Show file tree
Hide file tree
Showing 177 changed files with 7,779 additions and 5,404 deletions.
99 changes: 66 additions & 33 deletions PowerShell/JumpCloud Module/Docs/Add-JCAssociation.md
100755 → 100644
Original file line number Diff line number Diff line change
Expand Up @@ -14,14 +14,14 @@ Create an association between two object within the JumpCloud console.

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

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

## DESCRIPTION
Expand All @@ -45,74 +45,104 @@ Create an association between the radius server "RadiusServer1" and the user gro

## PARAMETERS

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

```yaml
Type: PSObject
Parameter Sets: (All)
Aliases: compiledAttributes

Required: False
Position: 15
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
```
### -Force
Bypass user confirmation and ValidateSet when adding or removing associations.
```yaml
Type: SwitchParameter
Parameter Sets: (All)
Aliases:

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

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

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

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

Required: True
Position: 4
Required: False
Position: 14
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
```
### -TargetName
The name of the target object.
### -TargetType
The type of the target object.
```yaml
Type: String
Parameter Sets: ByName
Aliases:
Type: 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: True
Position: 5
Expand All @@ -121,28 +151,31 @@ Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
```
### -TargetType
The type of the target object.
### -Type
The type of the object.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Accepted values: user, user_group, user_group, system, system_group, user, user_group, user, user_group, user, user_group, system, system_group, user_group, policy, user_group, command, system, policy, user, command, system_group, application, g_suite, ldap_server, office_365, radius_server, system_group, user, g_suite, ldap_server, office_365, system, user_group
Aliases: TypeNameSingular
Accepted values: command, ldap_server, policy, application, radius_server, system_group, system, user_group, user, g_suite, office_365

Required: True
Position: 3
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).
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
Expand Down
18 changes: 3 additions & 15 deletions PowerShell/JumpCloud Module/Docs/Add-JCCommandTarget.md
100755 → 100644
Original file line number Diff line number Diff line change
@@ -1,14 +1,13 @@
---
external help file: JumpCloud-help.xml
Module Name: JumpCloud
online version:
online version: https://github.com/TheJumpCloud/support/wiki/Add-JCCommandTarget
schema: 2.0.0
---

# Add-JCCommandTarget

## SYNOPSIS

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

## SYNTAX
Expand All @@ -29,7 +28,6 @@ Add-JCCommandTarget [-CommandID] <String> [-GroupName] <Object> [<CommonParamete
```

## 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
Expand Down Expand Up @@ -58,10 +56,8 @@ Adds the JumpCloud system group with the GroupID '5j03458a232z115210z66913' and
## 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: String
Parameter Sets: (All)
Expand All @@ -75,10 +71,8 @@ Accept wildcard characters: False
```
### -GroupID
The id value of a JumpCloud system group
```yaml
Type: Object
Parameter Sets: GroupID
Expand All @@ -92,7 +86,6 @@ 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
Expand All @@ -110,7 +103,6 @@ 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: Object
Parameter Sets: SystemID
Expand All @@ -124,19 +116,15 @@ 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).
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
### System.Object
## OUTPUTS
### System.Object
## NOTES
## RELATED LINKS
[Online Help Add-JCCommandTarget](https://github.com/TheJumpCloud/support/wiki/Add-JCCommandTarget)
Loading

0 comments on commit 52e3447

Please sign in to comment.