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 Feb 1, 2024
1 parent 71f5682 commit decbece
Show file tree
Hide file tree
Showing 121 changed files with 2,127 additions and 244 deletions.
23 changes: 19 additions & 4 deletions docs/Add-FGTFirewallAddress.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,28 +16,28 @@ Add a FortiGate Address
```
Add-FGTFirewallAddress -name <String> [-fqdn <String>] [-interface <String>] [-comment <String>]
[-visibility <Boolean>] [-allowrouting] [-data <Hashtable>] [-vdom <String[]>] [-connection <PSObject>]
[<CommonParameters>]
[-ProgressAction <ActionPreference>] [<CommonParameters>]
```

### ipmask
```
Add-FGTFirewallAddress -name <String> [-ip <IPAddress>] [-mask <IPAddress>] [-interface <String>]
[-comment <String>] [-visibility <Boolean>] [-allowrouting] [-data <Hashtable>] [-vdom <String[]>]
[-connection <PSObject>] [<CommonParameters>]
[-connection <PSObject>] [-ProgressAction <ActionPreference>] [<CommonParameters>]
```

### iprange
```
Add-FGTFirewallAddress -name <String> [-startip <IPAddress>] [-endip <IPAddress>] [-interface <String>]
[-comment <String>] [-visibility <Boolean>] [-allowrouting] [-data <Hashtable>] [-vdom <String[]>]
[-connection <PSObject>] [<CommonParameters>]
[-connection <PSObject>] [-ProgressAction <ActionPreference>] [<CommonParameters>]
```

### geography
```
Add-FGTFirewallAddress -name <String> [-country <String>] [-interface <String>] [-comment <String>]
[-visibility <Boolean>] [-allowrouting] [-data <Hashtable>] [-vdom <String[]>] [-connection <PSObject>]
[<CommonParameters>]
[-ProgressAction <ActionPreference>] [<CommonParameters>]
```

## DESCRIPTION
Expand Down Expand Up @@ -314,6 +314,21 @@ 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).
Expand Down
18 changes: 17 additions & 1 deletion docs/Add-FGTFirewallAddressGroup.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,8 @@ Add a FortiGate Address Group

```
Add-FGTFirewallAddressGroup [-name] <String> [-member] <String[]> [[-comment] <String>]
[[-visibility] <Boolean>] [[-vdom] <String[]>] [[-connection] <PSObject>] [<CommonParameters>]
[[-visibility] <Boolean>] [[-vdom] <String[]>] [[-connection] <PSObject>] [-ProgressAction <ActionPreference>]
[<CommonParameters>]
```

## DESCRIPTION
Expand Down Expand Up @@ -135,6 +136,21 @@ 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).
Expand Down
17 changes: 16 additions & 1 deletion docs/Add-FGTFirewallAddressGroupMember.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ Add a FortiGate Address Group Member

```
Add-FGTFirewallAddressGroupMember [-addrgrp] <PSObject> [-member <String[]>] [-vdom <String[]>]
[-connection <PSObject>] [<CommonParameters>]
[-connection <PSObject>] [-ProgressAction <ActionPreference>] [<CommonParameters>]
```

## DESCRIPTION
Expand Down Expand Up @@ -100,6 +100,21 @@ 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).
Expand Down
17 changes: 16 additions & 1 deletion docs/Add-FGTFirewallPolicy.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ Add a FortiGate Policy
Add-FGTFirewallPolicy [[-name] <String>] [[-policyid] <Int32>] [-srcintf] <String[]> [-dstintf] <String[]>
[-srcaddr] <String[]> [-dstaddr] <String[]> [[-action] <String>] [-status] [[-schedule] <String>]
[[-service] <String[]>] [-nat] [[-comments] <String>] [[-logtraffic] <String>] [[-ippool] <String[]>] [-skip]
[[-vdom] <String[]>] [[-connection] <PSObject>] [<CommonParameters>]
[[-vdom] <String[]>] [[-connection] <PSObject>] [-ProgressAction <ActionPreference>] [<CommonParameters>]
```

## DESCRIPTION
Expand Down Expand Up @@ -352,6 +352,21 @@ 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).
Expand Down
17 changes: 16 additions & 1 deletion docs/Add-FGTFirewallPolicyMember.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ Add a FortiGate Policy Member

```
Add-FGTFirewallPolicyMember [-policy] <PSObject> [-srcaddr <String[]>] [-dstaddr <String[]>] [-vdom <String[]>]
[-connection <PSObject>] [-WhatIf] [-Confirm] [<CommonParameters>]
[-connection <PSObject>] [-ProgressAction <ActionPreference>] [-WhatIf] [-Confirm] [<CommonParameters>]
```

## DESCRIPTION
Expand Down Expand Up @@ -146,6 +146,21 @@ 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).
Expand Down
25 changes: 21 additions & 4 deletions docs/Add-FGTFirewallProxyAddress.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,25 +15,27 @@ Add a FortiGate ProxyAddress
### default (Default)
```
Add-FGTFirewallProxyAddress -name <String> [-comment <String>] [-visibility <Boolean>] [-vdom <String[]>]
[-connection <PSObject>] [<CommonParameters>]
[-connection <PSObject>] [-ProgressAction <ActionPreference>] [<CommonParameters>]
```

### host-regex
```
Add-FGTFirewallProxyAddress -name <String> [-hostregex <String>] [-comment <String>] [-visibility <Boolean>]
[-vdom <String[]>] [-connection <PSObject>] [<CommonParameters>]
[-vdom <String[]>] [-connection <PSObject>] [-ProgressAction <ActionPreference>] [<CommonParameters>]
```

### url
```
Add-FGTFirewallProxyAddress -name <String> [-path <String>] [-hostObjectName <String>] [-comment <String>]
[-visibility <Boolean>] [-vdom <String[]>] [-connection <PSObject>] [<CommonParameters>]
[-visibility <Boolean>] [-vdom <String[]>] [-connection <PSObject>] [-ProgressAction <ActionPreference>]
[<CommonParameters>]
```

### method
```
Add-FGTFirewallProxyAddress -name <String> [-method <String>] [-hostObjectName <String>] [-comment <String>]
[-visibility <Boolean>] [-vdom <String[]>] [-connection <PSObject>] [<CommonParameters>]
[-visibility <Boolean>] [-vdom <String[]>] [-connection <PSObject>] [-ProgressAction <ActionPreference>]
[<CommonParameters>]
```

## DESCRIPTION
Expand Down Expand Up @@ -201,6 +203,21 @@ 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).
Expand Down
18 changes: 17 additions & 1 deletion docs/Add-FGTFirewallProxyAddressGroup.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,8 @@ Add a FortiGate ProxyAddress Group

```
Add-FGTFirewallProxyAddressGroup [-type] <String> [-name] <String> [-member] <String[]> [[-comment] <String>]
[[-visibility] <Boolean>] [[-vdom] <String[]>] [[-connection] <PSObject>] [<CommonParameters>]
[[-visibility] <Boolean>] [[-vdom] <String[]>] [[-connection] <PSObject>] [-ProgressAction <ActionPreference>]
[<CommonParameters>]
```

## DESCRIPTION
Expand Down Expand Up @@ -150,6 +151,21 @@ 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).
Expand Down
17 changes: 16 additions & 1 deletion docs/Add-FGTFirewallProxyAddressGroupMember.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ Add a FortiGate ProxyAddress Group Member

```
Add-FGTFirewallProxyAddressGroupMember [-addrgrp] <PSObject> [-member <String[]>] [-vdom <String[]>]
[-connection <PSObject>] [<CommonParameters>]
[-connection <PSObject>] [-ProgressAction <ActionPreference>] [<CommonParameters>]
```

## DESCRIPTION
Expand Down Expand Up @@ -100,6 +100,21 @@ 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).
Expand Down
17 changes: 16 additions & 1 deletion docs/Add-FGTFirewallProxyPolicy.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ Add a FortiGate Proxy Policy
Add-FGTFirewallProxyPolicy [-proxy] <String> [[-policyid] <Int32>] [[-srcintf] <String[]>]
[-dstintf] <String[]> [-srcaddr] <String[]> [-dstaddr] <String[]> [[-action] <String>] [-status]
[[-schedule] <String>] [[-service] <String[]>] [[-comments] <String>] [[-logtraffic] <String>] [-skip]
[[-vdom] <String[]>] [[-connection] <PSObject>] [<CommonParameters>]
[[-vdom] <String[]>] [[-connection] <PSObject>] [-ProgressAction <ActionPreference>] [<CommonParameters>]
```

## DESCRIPTION
Expand Down Expand Up @@ -308,6 +308,21 @@ 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).
Expand Down
17 changes: 16 additions & 1 deletion docs/Add-FGTFirewallVip.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ Add a FortiGate Virtual IP
Add-FGTFirewallVip [-type] <String> [-name] <String> [-extip] <IPAddress> [-mappedip] <IPAddress>
[[-interface] <String>] [[-comment] <String>] [-portforward] [[-protocol] <String>] [[-extport] <String>]
[[-mappedport] <String>] [[-arpreply] <Boolean>] [[-data] <Hashtable>] [-skip] [[-vdom] <String[]>]
[[-connection] <PSObject>] [<CommonParameters>]
[[-connection] <PSObject>] [-ProgressAction <ActionPreference>] [<CommonParameters>]
```

## DESCRIPTION
Expand Down Expand Up @@ -288,6 +288,21 @@ 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).
Expand Down
17 changes: 16 additions & 1 deletion docs/Add-FGTFirewallVipGroup.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ Add a FortiGate VIP Group

```
Add-FGTFirewallVipGroup [-name] <String> [-member] <String[]> [[-interface] <String>] [[-comments] <String>]
[[-vdom] <String[]>] [[-connection] <PSObject>] [<CommonParameters>]
[[-vdom] <String[]>] [[-connection] <PSObject>] [-ProgressAction <ActionPreference>] [<CommonParameters>]
```

## DESCRIPTION
Expand Down Expand Up @@ -135,6 +135,21 @@ 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).
Expand Down
Loading

0 comments on commit decbece

Please sign in to comment.