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 Jan 14, 2025
1 parent fcc0072 commit 0763c01
Show file tree
Hide file tree
Showing 3 changed files with 223 additions and 0 deletions.
44 changes: 44 additions & 0 deletions docs/Add-FGTFirewallAddress.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,13 @@ Add-FGTFirewallAddress -name <String> [-mac <String[]>] [-interface <String>] [-
[-ProgressAction <ActionPreference>] [<CommonParameters>]
```

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

## DESCRIPTION
Add a FortiGate Address (ipmask, iprange, fqdn)

Expand Down Expand Up @@ -110,6 +117,13 @@ Add Address object type mac (macaddr) with name FGT-Mac and value 01:02:03:04:05

### EXAMPLE 9
```
Add-FGTFirewallAddress -Name FGT-Dynamic-SDN-MyVM -sdn MyVcenter -filter VMNAME=MyVM
```

Add Address object type dynamic (SDN) MyVcenter with name FGT-Dynamic-SDN-MyVM and filter VMNAME=MyVM

### EXAMPLE 10
```
$data = @{ "color" = 23 }
PS C:\>Add-FGTFirewallAddress -Name FGT -ip 192.0.2.0 -mask 255.255.255.0 -data $data
```
Expand Down Expand Up @@ -238,6 +252,36 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -sdn
{{ Fill sdn Description }}
```yaml
Type: String
Parameter Sets: dynamic
Aliases:

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

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -interface
{{ Fill interface Description }}
Expand Down
133 changes: 133 additions & 0 deletions docs/Get-FGTMonitorFirewallAddressDynamic.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,133 @@
---
external help file: PowerFGT-help.xml
Module Name: PowerFGT
online version:
schema: 2.0.0
---

# Get-FGTMonitorFirewallAddressDynamic

## SYNOPSIS
Get Monitor Firewall Address Dynamic

## SYNTAX

```
Get-FGTMonitorFirewallAddressDynamic [[-dynamic] <String>] [-skip] [-vdom <String[]>] [-connection <PSObject>]
[-ProgressAction <ActionPreference>] [<CommonParameters>]
```

## DESCRIPTION
Get Monitor Firewall Adresss Dynamic (addr, subtype...)

## EXAMPLES

### EXAMPLE 1
```
Get-FGTMonitorFirewallAddressDynamic
```

Get ALL Firewall Address Dynamic

### EXAMPLE 2
```
Get-FGTMonitorFirewallAddressDynamic -dynamic mySDN
```

Get Firewall Address Dynamic of mySDN

### EXAMPLE 3
```
Get-FGTMonitorFirewallAddressDynamic -vdom vdomX
```

Get Firewall Address Dynamic of vdomX

## PARAMETERS

### -dynamic
{{ Fill dynamic Description }}

```yaml
Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 2
Default value: None
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.
```yaml
Type: SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: False
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
46 changes: 46 additions & 0 deletions docs/Set-FGTFirewallAddress.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,14 @@ Set-FGTFirewallAddress [-address] <PSObject> [-name <String>] [-mac <String[]>]
[-connection <PSObject>] [-ProgressAction <ActionPreference>] [-WhatIf] [-Confirm] [<CommonParameters>]
```

### dynamic
```
Set-FGTFirewallAddress [-address] <PSObject> [-name <String>] [-sdn <String>] [-filter <String>]
[-interface <String>] [-comment <String>] [-visibility <Boolean>] [-allowrouting] [-data <Hashtable>]
[-vdom <String[]>] [-connection <PSObject>] [-ProgressAction <ActionPreference>] [-WhatIf] [-Confirm]
[<CommonParameters>]
```

## DESCRIPTION
Change a FortiGate Address (ip, mask, comment, associated interface...
)
Expand Down Expand Up @@ -136,6 +144,14 @@ Change MyFGTAddress to set a new mac address 01:02:03:04:05:06

### EXAMPLE 10
```
$MyFGTAddress = Get-FGTFirewallAddress -name MyFGTAddress
PS C:\>$MyFGTAddress | Set-FGTFirewallAddress -filter VMNAME=MyVM
```

Change MyFGTAddress to set a new filter VMNANME=MyVM

### EXAMPLE 11
```
$data = @{ "color" = 23 }
PS C:\>$MyFGTAddress = Get-FGTFirewallAddress -name MyFGTAddress
PS C:\>$MyFGTAddress | Set-FGTFirewallAddress -data $color
Expand Down Expand Up @@ -280,6 +296,36 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -sdn
{{ Fill sdn Description }}
```yaml
Type: String
Parameter Sets: dynamic
Aliases:

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

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -interface
{{ Fill interface Description }}
Expand Down

0 comments on commit 0763c01

Please sign in to comment.