-
Notifications
You must be signed in to change notification settings - Fork 37
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Update doc via platyPS and GitHub Actions
- Loading branch information
FortiPower GitHub Actions Bot
committed
Sep 15, 2024
1 parent
6bc7f3e
commit 36195e0
Showing
7 changed files
with
976 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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] <String> [[-member] <String[]>] [[-data] <Hashtable>] [[-vdom] <String[]>] | ||
[[-connection] <PSObject>] [-ProgressAction <ActionPreference>] [<CommonParameters>] | ||
``` | ||
|
||
## 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 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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] <PSObject> [-member <String[]>] [-vdom <String[]>] [-connection <PSObject>] | ||
[-ProgressAction <ActionPreference>] [<CommonParameters>] | ||
``` | ||
|
||
## 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 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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] <Object> [-ProgressAction <ActionPreference>] [<CommonParameters>] | ||
``` | ||
|
||
## 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 |
Oops, something went wrong.