mirror of
https://github.com/freedbygrace/PSOPNSenseAPI.git
synced 2026-08-11 11:18:32 +00:00
Added comprehensive cmdlet documentation and updated module version to 2025.04.15.1033
This commit is contained in:
@@ -0,0 +1,45 @@
|
||||
# Get-OPNSenseSystemStatus
|
||||
|
||||
## SYNOPSIS
|
||||
Gets system status information from an OPNSense firewall.
|
||||
|
||||
## SYNTAX
|
||||
|
||||
```
|
||||
Get-OPNSenseSystemStatus
|
||||
```
|
||||
|
||||
## DESCRIPTION
|
||||
The Get-OPNSenseSystemStatus cmdlet retrieves system status information from an OPNSense firewall, including CPU usage, memory usage, disk usage, and uptime.
|
||||
|
||||
## EXAMPLES
|
||||
|
||||
### Example 1: Get system status
|
||||
```powershell
|
||||
Get-OPNSenseSystemStatus
|
||||
```
|
||||
|
||||
This example retrieves system status information from the 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
|
||||
|
||||
### System.Object
|
||||
Returns an object representing the system status information.
|
||||
|
||||
## NOTES
|
||||
This cmdlet requires a connection to an OPNSense firewall. Use Connect-OPNSense to establish a connection.
|
||||
|
||||
## RELATED LINKS
|
||||
|
||||
[Get-OPNSenseSystemInfo](Get-OPNSenseSystemInfo.md)
|
||||
[Restart-OPNSenseSystem](Restart-OPNSenseSystem.md)
|
||||
[Stop-OPNSenseSystem](Stop-OPNSenseSystem.md)
|
||||
Reference in New Issue
Block a user