diff --git a/docs/Add-FGTUserGroup.md b/docs/Add-FGTUserGroup.md new file mode 100644 index 000000000..73e40038b --- /dev/null +++ b/docs/Add-FGTUserGroup.md @@ -0,0 +1,148 @@ +--- +external help file: PowerFGT-help.xml +Module Name: PowerFGT +online version: +schema: 2.0.0 +--- + +# Add-FGTUserGroup + +## SYNOPSIS +Add a FortiGate User Group + +## SYNTAX + +``` +Add-FGTUserGroup [-name] [[-member] ] [[-data] ] [[-vdom] ] + [[-connection] ] [-ProgressAction ] [] +``` + +## DESCRIPTION +Add a FortiGate User Group + +## EXAMPLES + +### EXAMPLE 1 +``` +Add-FGTUserGroup -name MyUserGroup -member MyUser1 +``` + +Add User Group with member MyUser1 + +### EXAMPLE 2 +``` +Add-FGTUserGroup -name MyUserGroup -member MyUser1, MyUser2 +``` + +Add User Group with members MyUser1 and MyUser2 + +### EXAMPLE 3 +``` +$data = @{ "authtimeout" = 23 } +PS C:\>Add-FGTUserGroup -name MyUserGroup -member MyUser1 -data $data +``` + +Add User Group with member MyUser1and authtimeout (23) via -data parameter + +## PARAMETERS + +### -name +{{ Fill name Description }} + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -member +{{ Fill member Description }} + +```yaml +Type: String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -data +{{ Fill data Description }} + +```yaml +Type: Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: 3 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -vdom +{{ Fill vdom Description }} + +```yaml +Type: String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: 4 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -connection +{{ Fill connection Description }} + +```yaml +Type: PSObject +Parameter Sets: (All) +Aliases: + +Required: False +Position: 5 +Default value: $DefaultFGTConnection +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: ActionPreference +Parameter Sets: (All) +Aliases: proga + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +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 + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/docs/Add-FGTUserGroupMember.md b/docs/Add-FGTUserGroupMember.md new file mode 100644 index 000000000..105941a85 --- /dev/null +++ b/docs/Add-FGTUserGroupMember.md @@ -0,0 +1,127 @@ +--- +external help file: PowerFGT-help.xml +Module Name: PowerFGT +online version: +schema: 2.0.0 +--- + +# Add-FGTUserGroupMember + +## SYNOPSIS +Add a FortiGate User Group Member + +## SYNTAX + +``` +Add-FGTUserGroupMember [-usergroup] [-member ] [-vdom ] [-connection ] + [-ProgressAction ] [] +``` + +## DESCRIPTION +Add a FortiGate User Group Member + +## EXAMPLES + +### EXAMPLE 1 +``` +$MyFGTUserGroup = Get-FGTUserGroup -name MyFGTUserGroup +PS C:\>$MyFGTUserGroup | Add-FGTUserGroupMember -member MyUser1 +``` + +Add MyUser1 member to MyFGTUserGroup + +### EXAMPLE 2 +``` +$MyFGTUserGroup = Get-FGTUserGroup -name MyFGTUserGroup +PS C:\>$MyFGTUserGroup | Add-FGTUserGroupMember -member MyUser1, MyUser2 +``` + +Add MyUser1 and MyUser2 member to MyFGTUserGroup + +## PARAMETERS + +### -usergroup +{{ Fill usergroup Description }} + +```yaml +Type: PSObject +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -member +{{ Fill member Description }} + +```yaml +Type: String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -vdom +{{ Fill vdom Description }} + +```yaml +Type: String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -connection +{{ Fill connection Description }} + +```yaml +Type: PSObject +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: $DefaultFGTConnection +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: ActionPreference +Parameter Sets: (All) +Aliases: proga + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +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 + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/docs/Confirm-FGTUserGroup.md b/docs/Confirm-FGTUserGroup.md new file mode 100644 index 000000000..73c651e86 --- /dev/null +++ b/docs/Confirm-FGTUserGroup.md @@ -0,0 +1,75 @@ +--- +external help file: PowerFGT-help.xml +Module Name: PowerFGT +online version: +schema: 2.0.0 +--- + +# Confirm-FGTUserGroup + +## SYNOPSIS +{{ Fill in the Synopsis }} + +## SYNTAX + +``` +Confirm-FGTUserGroup [-argument] [-ProgressAction ] [] +``` + +## DESCRIPTION +{{ Fill in the Description }} + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -argument +{{ Fill argument Description }} + +```yaml +Type: Object +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: ActionPreference +Parameter Sets: (All) +Aliases: proga + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +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 + +### None + +## OUTPUTS + +### System.Object +## NOTES + +## RELATED LINKS diff --git a/docs/Copy-FGTUserGroup.md b/docs/Copy-FGTUserGroup.md new file mode 100644 index 000000000..e36418cba --- /dev/null +++ b/docs/Copy-FGTUserGroup.md @@ -0,0 +1,119 @@ +--- +external help file: PowerFGT-help.xml +Module Name: PowerFGT +online version: +schema: 2.0.0 +--- + +# Copy-FGTUserGroup + +## SYNOPSIS +Copy/Clone a FortiGate User Group + +## SYNTAX + +``` +Copy-FGTUserGroup [-usergroup] -name [-vdom ] [-connection ] + [-ProgressAction ] [] +``` + +## DESCRIPTION +Copy/Clone a FortiGate User Group (name, member...) + +## EXAMPLES + +### EXAMPLE 1 +``` +$MyFGTUserGroup = Get-FGTUserGroup -name MyFGTUserGroup +PS C:\>$MyFGTUserGroup | Copy-FGTUserGroup -name MyFGTUserGroup_copy +``` + +Copy / Clone MyFGTUserGroup and name MyFGTUser_copy + +## PARAMETERS + +### -usergroup +{{ Fill usergroup Description }} + +```yaml +Type: PSObject +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -name +{{ Fill name Description }} + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -vdom +{{ Fill vdom Description }} + +```yaml +Type: String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -connection +{{ Fill connection Description }} + +```yaml +Type: PSObject +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: $DefaultFGTConnection +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: ActionPreference +Parameter Sets: (All) +Aliases: proga + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +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 + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/docs/Remove-FGTUserGroup.md b/docs/Remove-FGTUserGroup.md new file mode 100644 index 000000000..5e9e714b9 --- /dev/null +++ b/docs/Remove-FGTUserGroup.md @@ -0,0 +1,143 @@ +--- +external help file: PowerFGT-help.xml +Module Name: PowerFGT +online version: +schema: 2.0.0 +--- + +# Remove-FGTUserGroup + +## SYNOPSIS +Remove a FortiGate User + +## SYNTAX + +``` +Remove-FGTUserGroup [-usergroup] [-vdom ] [-connection ] + [-ProgressAction ] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +Remove an User Group object on the FortiGate + +## EXAMPLES + +### EXAMPLE 1 +``` +$MyFGTUserGroup = Get-FGTUserGroup -name MyFGTUserGroup +PS C:\>$MyFGTUserGroup | Remove-FGTUserGroup +``` + +Remove User Group object $MyFGTUserGroup + +### EXAMPLE 2 +``` +$MyFGTUserGroup = Get-FGTUserGroup -name MyFGTUserGroup +PS C:\>$MyFGTUserGroup | Remove-FGTUserGroup -confirm:$false +``` + +Remove User object $MyFGTUserGroup with no confirmation + +## PARAMETERS + +### -usergroup +{{ Fill usergroup Description }} + +```yaml +Type: PSObject +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -vdom +{{ Fill vdom Description }} + +```yaml +Type: String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -connection +{{ Fill connection Description }} + +```yaml +Type: PSObject +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: $DefaultFGTConnection +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: ActionPreference +Parameter Sets: (All) +Aliases: proga + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +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 + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/docs/Remove-FGTUserGroupMember.md b/docs/Remove-FGTUserGroupMember.md new file mode 100644 index 000000000..b14a6628e --- /dev/null +++ b/docs/Remove-FGTUserGroupMember.md @@ -0,0 +1,158 @@ +--- +external help file: PowerFGT-help.xml +Module Name: PowerFGT +online version: +schema: 2.0.0 +--- + +# Remove-FGTUserGroupMember + +## SYNOPSIS +Remove a FortiGate User Group Member + +## SYNTAX + +``` +Remove-FGTUserGroupMember [-usergroup] [-member ] [-vdom ] + [-connection ] [-ProgressAction ] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +Remove a FortiGate User Group Member + +## EXAMPLES + +### EXAMPLE 1 +``` +$MyFGTUserGroup = Get-FGTUserGroup -name MyFGTUserGroup +PS C:\>$MyFGTUserGroup | Remove-FGTUserGroupMember -member MyUser1 +``` + +Remove MyUser1 member to MyFGTUserGroup + +### EXAMPLE 2 +``` +$MyFGTUserGroup = Get-FGTUserGroup -name MyFGTUserGroup +PS C:\>$MyFGTUserGroup | Remove-FGTUserGroupMember -member MyUser1, MyUser2 +``` + +Remove MyUser1 and MyUser2 member to MyFGTUserGroup + +## PARAMETERS + +### -usergroup +{{ Fill usergroup Description }} + +```yaml +Type: PSObject +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -member +{{ Fill member Description }} + +```yaml +Type: String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -vdom +{{ Fill vdom Description }} + +```yaml +Type: String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -connection +{{ Fill connection Description }} + +```yaml +Type: PSObject +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: $DefaultFGTConnection +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: ActionPreference +Parameter Sets: (All) +Aliases: proga + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +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 + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/docs/Set-FGTUserGroup.md b/docs/Set-FGTUserGroup.md new file mode 100644 index 000000000..5be3318d4 --- /dev/null +++ b/docs/Set-FGTUserGroup.md @@ -0,0 +1,206 @@ +--- +external help file: PowerFGT-help.xml +Module Name: PowerFGT +online version: +schema: 2.0.0 +--- + +# Set-FGTUserGroup + +## SYNOPSIS +Configure a FortiGate User Group + +## SYNTAX + +``` +Set-FGTUserGroup [-usergroup] [-name ] [-member ] [-data ] + [-vdom ] [-connection ] [-ProgressAction ] [-WhatIf] [-Confirm] + [] +``` + +## DESCRIPTION +Change a FortiGate User Group (name, member...) + +## EXAMPLES + +### EXAMPLE 1 +``` +$MyFGTUserGroup = Get-FGTUserGroup -name MyFGTUserGroup +PS C:\>$MyFGTUserGroup | Set-FGTUserGroup -member MyUser1 +``` + +Change MyFGTUserGroup member to MyUser1 + +### EXAMPLE 2 +``` +$MyFGTUserGroup = Get-FGTUserGroup -name MyFGTUserGroup +PS C:\>$MyFGTUserGroup | Set-FGTUserGroup -member MyUser1, MyUser2 +``` + +Change MyFGTUserGroup member to MyUser1 and MyUser2 + +### EXAMPLE 3 +``` +$MyFGTUserGroup = Get-FGTUserGroup -name MyFGTUserGroup +PS C:\>$MyFGTUserGroup | Set-FGTUserGroup -name MyFGTUserGroup2 +``` + +Rename MyFGTUserGroup member to MyFGTUserGroup2 + +### EXAMPLE 4 +``` +$data = @{ "authtimeout" = 23 } +PS C:\>$MyFGTUserGroup = Get-FGTUserGroup -name MyFGTUserGroup +PS C:\>$MyFGTUserGroup | Set-FGTUserGroup -data $data +``` + +Change MyFGTUserGroup to set authtimeout (23) using -data + +## PARAMETERS + +### -usergroup +{{ Fill usergroup Description }} + +```yaml +Type: PSObject +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -name +{{ Fill name Description }} + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -member +{{ Fill member Description }} + +```yaml +Type: String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -data +{{ Fill data Description }} + +```yaml +Type: Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -vdom +{{ Fill vdom Description }} + +```yaml +Type: String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -connection +{{ Fill connection Description }} + +```yaml +Type: PSObject +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: $DefaultFGTConnection +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: ActionPreference +Parameter Sets: (All) +Aliases: proga + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +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 + +## OUTPUTS + +## NOTES + +## RELATED LINKS