Skip to content

Commit

Permalink
Update doc via platyPS and GitHub Actions
Browse files Browse the repository at this point in the history
  • Loading branch information
FortiPower GitHub Actions Bot committed Oct 7, 2024
1 parent 5657567 commit 66ff194
Show file tree
Hide file tree
Showing 2 changed files with 142 additions and 9 deletions.
77 changes: 72 additions & 5 deletions docs/Add-FGTUserLocal.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,13 +12,38 @@ Add a FortiGate Local User

## SYNTAX

### password
```
Add-FGTUserLocal -name <String> [-status] [-passwd <SecureString>] [-two_factor <String>]
[-two_factor_notification <String>] [-fortitoken <String>] [-email_to <String>] [-sms_phone <String>]
[-data <Hashtable>] [-vdom <String[]>] [-connection <PSObject>] [-ProgressAction <ActionPreference>]
[<CommonParameters>]
```

### radius
```
Add-FGTUserLocal -name <String> [-status] [-radius_server <String>] [-two_factor <String>]
[-two_factor_notification <String>] [-fortitoken <String>] [-email_to <String>] [-sms_phone <String>]
[-data <Hashtable>] [-vdom <String[]>] [-connection <PSObject>] [-ProgressAction <ActionPreference>]
[<CommonParameters>]
```

### tacacs
```
Add-FGTUserLocal -name <String> [-status] [-tacacs_server <String>] [-two_factor <String>]
[-two_factor_notification <String>] [-fortitoken <String>] [-email_to <String>] [-sms_phone <String>]
[-data <Hashtable>] [-vdom <String[]>] [-connection <PSObject>] [-ProgressAction <ActionPreference>]
[<CommonParameters>]
```

### ldap
```
Add-FGTUserLocal -name <String> [-status] [-ldap_server <String>] [-two_factor <String>]
[-two_factor_notification <String>] [-fortitoken <String>] [-email_to <String>] [-sms_phone <String>]
[-data <Hashtable>] [-vdom <String[]>] [-connection <PSObject>] [-ProgressAction <ActionPreference>]
[<CommonParameters>]
```

## DESCRIPTION
Add a FortiGate Local User (Name, Password, MFA)

Expand Down Expand Up @@ -94,7 +119,52 @@ Accept wildcard characters: False
```yaml
Type: SecureString
Parameter Sets: (All)
Parameter Sets: password
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -radius_server
{{ Fill radius_server Description }}
```yaml
Type: String
Parameter Sets: radius
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -tacacs_server
{{ Fill tacacs_server Description }}
```yaml
Type: String
Parameter Sets: tacacs
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -ldap_server
{{ Fill ldap_server Description }}
```yaml
Type: String
Parameter Sets: ldap
Aliases:

Required: False
Expand All @@ -105,10 +175,7 @@ Accept wildcard characters: False
```
### -two_factor
\[Parameter (Mandatory = $false, ParameterSetName = "radius")\]
\[string\]$radius_server,
\[Parameter (Mandatory = $false, ParameterSetName = "tacacs")\]
\[string\]$tacacs_server,
{{ Fill two_factor Description }}
```yaml
Type: String
Expand Down
74 changes: 70 additions & 4 deletions docs/Set-FGTUserLocal.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,30 @@ Set-FGTUserLocal [-userlocal] <PSObject> [-name <String>] [-status] [-passwd <Se
[-ProgressAction <ActionPreference>] [-WhatIf] [-Confirm] [<CommonParameters>]
```

### radius
```
Set-FGTUserLocal [-userlocal] <PSObject> [-name <String>] [-status] [-radius_server <String>]
[-two_factor <String>] [-two_factor_notification <String>] [-fortitoken <String>] [-email_to <String>]
[-sms_phone <String>] [-data <Hashtable>] [-vdom <String[]>] [-connection <PSObject>]
[-ProgressAction <ActionPreference>] [-WhatIf] [-Confirm] [<CommonParameters>]
```

### tacacs
```
Set-FGTUserLocal [-userlocal] <PSObject> [-name <String>] [-status] [-tacacs_server <String>]
[-two_factor <String>] [-two_factor_notification <String>] [-fortitoken <String>] [-email_to <String>]
[-sms_phone <String>] [-data <Hashtable>] [-vdom <String[]>] [-connection <PSObject>]
[-ProgressAction <ActionPreference>] [-WhatIf] [-Confirm] [<CommonParameters>]
```

### ldap
```
Set-FGTUserLocal [-userlocal] <PSObject> [-name <String>] [-status] [-ldap_server <String>]
[-two_factor <String>] [-two_factor_notification <String>] [-fortitoken <String>] [-email_to <String>]
[-sms_phone <String>] [-data <Hashtable>] [-vdom <String[]>] [-connection <PSObject>]
[-ProgressAction <ActionPreference>] [-WhatIf] [-Confirm] [<CommonParameters>]
```

## DESCRIPTION
Change a FortiGate Local User

Expand Down Expand Up @@ -129,11 +153,53 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -radius_server
{{ Fill radius_server Description }}
```yaml
Type: String
Parameter Sets: radius
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -tacacs_server
{{ Fill tacacs_server Description }}
```yaml
Type: String
Parameter Sets: tacacs
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -ldap_server
{{ Fill ldap_server Description }}
```yaml
Type: String
Parameter Sets: ldap
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -two_factor
\[Parameter (Mandatory = $false, ParameterSetName = "radius")\]
\[string\]$radius_server,
\[Parameter (Mandatory = $false, ParameterSetName = "tacacs")\]
\[string\]$tacacs_server,
{{ Fill two_factor Description }}
```yaml
Type: String
Expand Down

0 comments on commit 66ff194

Please sign in to comment.