mirror of
https://github.com/freedbygrace/PSOPNSenseAPI.git
synced 2026-08-21 07:37:34 +00:00
Added comprehensive cmdlet documentation and updated module version to 2025.04.15.1033
This commit is contained in:
@@ -0,0 +1,43 @@
|
||||
# Disconnect-OPNSense
|
||||
|
||||
## SYNOPSIS
|
||||
Disconnects from an OPNSense firewall.
|
||||
|
||||
## SYNTAX
|
||||
|
||||
```
|
||||
Disconnect-OPNSense
|
||||
```
|
||||
|
||||
## DESCRIPTION
|
||||
The Disconnect-OPNSense cmdlet terminates the connection to an OPNSense firewall.
|
||||
|
||||
## EXAMPLES
|
||||
|
||||
### Example 1: Disconnect from an OPNSense firewall
|
||||
```powershell
|
||||
Disconnect-OPNSense
|
||||
```
|
||||
|
||||
This example disconnects from the currently connected OPNSense firewall.
|
||||
|
||||
## PARAMETERS
|
||||
|
||||
### 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
|
||||
|
||||
### None
|
||||
|
||||
## OUTPUTS
|
||||
|
||||
### None
|
||||
|
||||
## NOTES
|
||||
This cmdlet releases resources used by the connection to the OPNSense firewall.
|
||||
|
||||
## RELATED LINKS
|
||||
|
||||
[Connect-OPNSense](Connect-OPNSense.md)
|
||||
[Get-OPNSenseConnection](Get-OPNSenseConnection.md)
|
||||
Reference in New Issue
Block a user