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 224b90b commit 20f5d06
Show file tree
Hide file tree
Showing 28 changed files with 791 additions and 155 deletions.
36 changes: 29 additions & 7 deletions docs/Get-FGTFirewallAddress.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -14,28 +14,28 @@ Get list of all "address"

### default (Default)
```
Get-FGTFirewallAddress [-filter_attribute <String>] [-filter_type <String>] [-filter_value <PSObject>] [-skip]
[-vdom <String[]>] [-connection <PSObject>] [-ProgressAction <ActionPreference>] [<CommonParameters>]
Get-FGTFirewallAddress [-filter_attribute <String>] [-filter_type <String>] [-filter_value <PSObject>] [-meta]
[-skip] [-vdom <String[]>] [-connection <PSObject>] [-ProgressAction <ActionPreference>] [<CommonParameters>]
```

### name
```
Get-FGTFirewallAddress [[-name] <String>] [-filter_attribute <String>] [-filter_type <String>]
[-filter_value <PSObject>] [-skip] [-vdom <String[]>] [-connection <PSObject>]
[-filter_value <PSObject>] [-meta] [-skip] [-vdom <String[]>] [-connection <PSObject>]
[-ProgressAction <ActionPreference>] [<CommonParameters>]
```

### uuid
```
Get-FGTFirewallAddress [-uuid <String>] [-filter_attribute <String>] [-filter_type <String>]
[-filter_value <PSObject>] [-skip] [-vdom <String[]>] [-connection <PSObject>]
[-filter_value <PSObject>] [-meta] [-skip] [-vdom <String[]>] [-connection <PSObject>]
[-ProgressAction <ActionPreference>] [<CommonParameters>]
```

### filter
```
Get-FGTFirewallAddress [-filter_attribute <String>] [-filter_type <String>] [-filter_value <PSObject>] [-skip]
[-vdom <String[]>] [-connection <PSObject>] [-ProgressAction <ActionPreference>] [<CommonParameters>]
Get-FGTFirewallAddress [-filter_attribute <String>] [-filter_type <String>] [-filter_value <PSObject>] [-meta]
[-skip] [-vdom <String[]>] [-connection <PSObject>] [-ProgressAction <ActionPreference>] [<CommonParameters>]
```

## DESCRIPTION
Expand Down Expand Up @@ -73,12 +73,19 @@ Get address with uuid 9e73a10e-1772-51ea-a8d7-297686fd7702

### EXAMPLE 5
```
Get-FGTFirewallAddress -meta
```

Get list of all address object with metadata (q_...) like usage (q_ref)

### EXAMPLE 6
```
Get-FGTFirewallAddress -skip
```

Get list of all address object (but only relevant attributes)

### EXAMPLE 6
### EXAMPLE 7
```
Get-FGTFirewallAddress -vdom vdomX
```
Expand Down Expand Up @@ -162,6 +169,21 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -meta
{{ Fill meta Description }}
```yaml
Type: SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
```
### -skip
Ignores the specified number of objects and then gets the remaining objects.
Enter the number of objects to skip.
Expand Down
34 changes: 29 additions & 5 deletions docs/Get-FGTFirewallAddressGroup.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -15,27 +15,29 @@ Get addresses group configured
### default (Default)
```
Get-FGTFirewallAddressGroup [-filter_attribute <String>] [-filter_type <String>] [-filter_value <PSObject>]
[-skip] [-vdom <String[]>] [-connection <PSObject>] [-ProgressAction <ActionPreference>] [<CommonParameters>]
[-meta] [-skip] [-vdom <String[]>] [-connection <PSObject>] [-ProgressAction <ActionPreference>]
[<CommonParameters>]
```

### name
```
Get-FGTFirewallAddressGroup [[-name] <String>] [-filter_attribute <String>] [-filter_type <String>]
[-filter_value <PSObject>] [-skip] [-vdom <String[]>] [-connection <PSObject>]
[-filter_value <PSObject>] [-meta] [-skip] [-vdom <String[]>] [-connection <PSObject>]
[-ProgressAction <ActionPreference>] [<CommonParameters>]
```

### uuid
```
Get-FGTFirewallAddressGroup [-uuid <String>] [-filter_attribute <String>] [-filter_type <String>]
[-filter_value <PSObject>] [-skip] [-vdom <String[]>] [-connection <PSObject>]
[-filter_value <PSObject>] [-meta] [-skip] [-vdom <String[]>] [-connection <PSObject>]
[-ProgressAction <ActionPreference>] [<CommonParameters>]
```

### filter
```
Get-FGTFirewallAddressGroup [-filter_attribute <String>] [-filter_type <String>] [-filter_value <PSObject>]
[-skip] [-vdom <String[]>] [-connection <PSObject>] [-ProgressAction <ActionPreference>] [<CommonParameters>]
[-meta] [-skip] [-vdom <String[]>] [-connection <PSObject>] [-ProgressAction <ActionPreference>]
[<CommonParameters>]
```

## DESCRIPTION
Expand Down Expand Up @@ -73,12 +75,19 @@ Get Address Group with uuid 9e73a10e-1772-51ea-a8d7-297686fd7702

### EXAMPLE 5
```
Get-FGTFirewallAddressGroup -meta
```

Display all addresses group with metadata (q_...) like usage (q_ref)

### EXAMPLE 6
```
Get-FGTFirewallAddressGroup -skip
```

Display all addresses group (but only relevant attributes)

### EXAMPLE 6
### EXAMPLE 7
```
Get-FGTFirewallAddressGroup -vdom vdomX
```
Expand Down Expand Up @@ -162,6 +171,21 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -meta
{{ Fill meta Description }}
```yaml
Type: SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
```
### -skip
Ignores the specified number of objects and then gets the remaining objects.
Enter the number of objects to skip.
Expand Down
34 changes: 28 additions & 6 deletions docs/Get-FGTFirewallIPPool.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -14,21 +14,21 @@ Get list of all (NAT) ip pool"

### default (Default)
```
Get-FGTFirewallIPPool [-filter_attribute <String>] [-filter_type <String>] [-filter_value <PSObject>] [-skip]
[-vdom <String[]>] [-connection <PSObject>] [-ProgressAction <ActionPreference>] [<CommonParameters>]
Get-FGTFirewallIPPool [-filter_attribute <String>] [-filter_type <String>] [-filter_value <PSObject>] [-meta]
[-skip] [-vdom <String[]>] [-connection <PSObject>] [-ProgressAction <ActionPreference>] [<CommonParameters>]
```

### name
```
Get-FGTFirewallIPPool [[-name] <String>] [-filter_attribute <String>] [-filter_type <String>]
[-filter_value <PSObject>] [-skip] [-vdom <String[]>] [-connection <PSObject>]
[-filter_value <PSObject>] [-meta] [-skip] [-vdom <String[]>] [-connection <PSObject>]
[-ProgressAction <ActionPreference>] [<CommonParameters>]
```

### filter
```
Get-FGTFirewallIPPool [-filter_attribute <String>] [-filter_type <String>] [-filter_value <PSObject>] [-skip]
[-vdom <String[]>] [-connection <PSObject>] [-ProgressAction <ActionPreference>] [<CommonParameters>]
Get-FGTFirewallIPPool [-filter_attribute <String>] [-filter_type <String>] [-filter_value <PSObject>] [-meta]
[-skip] [-vdom <String[]>] [-connection <PSObject>] [-ProgressAction <ActionPreference>] [<CommonParameters>]
```

## DESCRIPTION
Expand Down Expand Up @@ -59,12 +59,19 @@ Get ip pool contains with *FGT*

### EXAMPLE 4
```
Get-FGTFirewallIPPool -meta
```

Get list of all (NAT) ip pool object with metadata (q_...) like usage (q_ref)

### EXAMPLE 5
```
Get-FGTFirewallIPPool -skip
```

Get list of all (NAT) ip pool object (but only relevant attributes)

### EXAMPLE 5
### EXAMPLE 6
```
Get-FGTFirewallIPPool -vdom vdomX
```
Expand Down Expand Up @@ -133,6 +140,21 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -meta
{{ Fill meta Description }}
```yaml
Type: SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
```
### -skip
Ignores the specified number of objects and then gets the remaining objects.
Enter the number of objects to skip.
Expand Down
36 changes: 29 additions & 7 deletions docs/Get-FGTFirewallPolicy.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -14,35 +14,35 @@ Get list of all policies/rules

### default (Default)
```
Get-FGTFirewallPolicy [-filter_attribute <String>] [-filter_type <String>] [-filter_value <PSObject>] [-skip]
[-vdom <String[]>] [-connection <PSObject>] [-ProgressAction <ActionPreference>] [<CommonParameters>]
Get-FGTFirewallPolicy [-filter_attribute <String>] [-filter_type <String>] [-filter_value <PSObject>] [-meta]
[-skip] [-vdom <String[]>] [-connection <PSObject>] [-ProgressAction <ActionPreference>] [<CommonParameters>]
```

### name
```
Get-FGTFirewallPolicy [[-name] <String>] [-filter_attribute <String>] [-filter_type <String>]
[-filter_value <PSObject>] [-skip] [-vdom <String[]>] [-connection <PSObject>]
[-filter_value <PSObject>] [-meta] [-skip] [-vdom <String[]>] [-connection <PSObject>]
[-ProgressAction <ActionPreference>] [<CommonParameters>]
```

### uuid
```
Get-FGTFirewallPolicy [-uuid <String>] [-filter_attribute <String>] [-filter_type <String>]
[-filter_value <PSObject>] [-skip] [-vdom <String[]>] [-connection <PSObject>]
[-filter_value <PSObject>] [-meta] [-skip] [-vdom <String[]>] [-connection <PSObject>]
[-ProgressAction <ActionPreference>] [<CommonParameters>]
```

### policyid
```
Get-FGTFirewallPolicy [-policyid <String>] [-filter_attribute <String>] [-filter_type <String>]
[-filter_value <PSObject>] [-skip] [-vdom <String[]>] [-connection <PSObject>]
[-filter_value <PSObject>] [-meta] [-skip] [-vdom <String[]>] [-connection <PSObject>]
[-ProgressAction <ActionPreference>] [<CommonParameters>]
```

### filter
```
Get-FGTFirewallPolicy [-filter_attribute <String>] [-filter_type <String>] [-filter_value <PSObject>] [-skip]
[-vdom <String[]>] [-connection <PSObject>] [-ProgressAction <ActionPreference>] [<CommonParameters>]
Get-FGTFirewallPolicy [-filter_attribute <String>] [-filter_type <String>] [-filter_value <PSObject>] [-meta]
[-skip] [-vdom <String[]>] [-connection <PSObject>] [-ProgressAction <ActionPreference>] [<CommonParameters>]
```

## DESCRIPTION
Expand Down Expand Up @@ -94,6 +94,13 @@ Get list of all policies (but only relevant attributes)

### EXAMPLE 7
```
Get-FGTFirewallPolicy -meta
```

Get list of all policies with metadata (q_...) like usage (q_ref)

### EXAMPLE 8
```
Get-FGTFirewallPolicy -vdom vdomX
```

Expand Down Expand Up @@ -191,6 +198,21 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -meta
{{ Fill meta Description }}
```yaml
Type: SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
```
### -skip
Ignores the specified number of objects and then gets the remaining objects.
Enter the number of objects to skip.
Expand Down
31 changes: 27 additions & 4 deletions docs/Get-FGTFirewallProxyAddress.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -14,26 +14,27 @@ Get list of all "proxy-address"

### default (Default)
```
Get-FGTFirewallProxyAddress [-skip] [-vdom <String[]>] [-connection <PSObject>]
Get-FGTFirewallProxyAddress [-meta] [-skip] [-vdom <String[]>] [-connection <PSObject>]
[-ProgressAction <ActionPreference>] [<CommonParameters>]
```

### name
```
Get-FGTFirewallProxyAddress [[-name] <String>] [-filter_type <String>] [-skip] [-vdom <String[]>]
Get-FGTFirewallProxyAddress [[-name] <String>] [-filter_type <String>] [-meta] [-skip] [-vdom <String[]>]
[-connection <PSObject>] [-ProgressAction <ActionPreference>] [<CommonParameters>]
```

### uuid
```
Get-FGTFirewallProxyAddress [-uuid <String>] [-filter_type <String>] [-skip] [-vdom <String[]>]
Get-FGTFirewallProxyAddress [-uuid <String>] [-filter_type <String>] [-meta] [-skip] [-vdom <String[]>]
[-connection <PSObject>] [-ProgressAction <ActionPreference>] [<CommonParameters>]
```

### filter_build
```
Get-FGTFirewallProxyAddress [-filter_attribute <String>] [-filter_type <String>] [-filter_value <PSObject>]
[-skip] [-vdom <String[]>] [-connection <PSObject>] [-ProgressAction <ActionPreference>] [<CommonParameters>]
[-meta] [-skip] [-vdom <String[]>] [-connection <PSObject>] [-ProgressAction <ActionPreference>]
[<CommonParameters>]
```

## DESCRIPTION
Expand Down Expand Up @@ -78,6 +79,13 @@ Get list of all proxy-address object (but only relevant attributes)

### EXAMPLE 6
```
Get-FGTFirewallProxyAddress -meta
```

Get list of all proxy-address object with metadata (q_...) like usage (q_ref)

### EXAMPLE 7
```
Get-FGTFirewallProxyAddress -vdom vdomX
```

Expand Down Expand Up @@ -160,6 +168,21 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -meta
{{ Fill meta Description }}
```yaml
Type: SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
```
### -skip
Ignores the specified number of objects and then gets the remaining objects.
Enter the number of objects to skip.
Expand Down
Loading

0 comments on commit 20f5d06

Please sign in to comment.