Files
PSOPNSenseAPI/docs/cmdlets/Get-OPNSenseSystemStatus.md
T

1.2 KiB

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

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.

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.

Get-OPNSenseSystemInfo Restart-OPNSenseSystem Stop-OPNSenseSystem