-
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
Jan 7, 2025
1 parent
56970c5
commit 12c49da
Showing
2 changed files
with
222 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,111 @@ | ||
--- | ||
external help file: PowerFGT-help.xml | ||
Module Name: PowerFGT | ||
online version: | ||
schema: 2.0.0 | ||
--- | ||
|
||
# Get-FGTMonitorRouterBGPNeighbors | ||
|
||
## SYNOPSIS | ||
Get Router BGP Neighbors | ||
|
||
## SYNTAX | ||
|
||
``` | ||
Get-FGTMonitorRouterBGPNeighbors [-skip] [[-vdom] <String[]>] [[-connection] <PSObject>] | ||
[-ProgressAction <ActionPreference>] [<CommonParameters>] | ||
``` | ||
|
||
## DESCRIPTION | ||
List all active discovered BGP neighbors (neighbor_ip, remote_as, state....) | ||
|
||
## EXAMPLES | ||
|
||
### EXAMPLE 1 | ||
``` | ||
Get-FGTMonitorRouterBGPNeighbors | ||
``` | ||
|
||
Get ALL Router BGP Neighbors | ||
|
||
### EXAMPLE 2 | ||
``` | ||
Get-FGTMonitorRouterBGPNeighbors -vdom vdomX | ||
``` | ||
|
||
Get Router BGP Neighbors monitor of vdomX | ||
|
||
## PARAMETERS | ||
|
||
### -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: 1 | ||
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: 2 | ||
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,111 @@ | ||
--- | ||
external help file: PowerFGT-help.xml | ||
Module Name: PowerFGT | ||
online version: | ||
schema: 2.0.0 | ||
--- | ||
|
||
# Get-FGTMonitorRouterOSPFNeighbors | ||
|
||
## SYNOPSIS | ||
Get Router OSPF Neighbors | ||
|
||
## SYNTAX | ||
|
||
``` | ||
Get-FGTMonitorRouterOSPFNeighbors [-skip] [[-vdom] <String[]>] [[-connection] <PSObject>] | ||
[-ProgressAction <ActionPreference>] [<CommonParameters>] | ||
``` | ||
|
||
## DESCRIPTION | ||
List all active discovered OSPF neighbors (ip, route-id, state, priority....) | ||
|
||
## EXAMPLES | ||
|
||
### EXAMPLE 1 | ||
``` | ||
Get-FGTMonitorRouterOSPFNeighbors | ||
``` | ||
|
||
Get ALL Router OSPF Neighbors | ||
|
||
### EXAMPLE 2 | ||
``` | ||
Get-FGTMonitorRouterOSPFNeighbors -vdom vdomX | ||
``` | ||
|
||
Get Router OSPF Neighbors monitor of vdomX | ||
|
||
## PARAMETERS | ||
|
||
### -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: 1 | ||
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: 2 | ||
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 |