Get‐OPNsense

Synopsis

Return the basic status information about the OPNsense server

Syntax

Get-OPNsense [-Mirror] [<CommonParameters>]

Get-OPNsense -Changelog -Version <String> [<CommonParameters>]

Description

Use this command to list basic status information of the OPNsense server, like its Product Version and Product Name. The command will first contact the mirror repository and check if any updates are available.

Use the Get-OPNsense cmdlet to retrieve the number of updates pending and to check whether a reboot will be needed. If updates are available, use the Update-OPNsense cmdlet to install them and reboot the server when required.

Parameters

-Mirror   <SwitchParameter>

List the OPNsense package mirrors

Required?	false
Position?	named
Default Value?
Pipeline Input?	false

-Changelog   <SwitchParameter>

Required?	true
Position?	named
Default Value?
Pipeline Input?	false

-Version   <String>

Required?	true
Position?	named
Default Value?
Pipeline Input?	false

Examples

Basic example

Get-OPNsense -Verbose

List non-commercial mirrors

Get-OPNsense -Mirror | Where-Object { -Not $_.Commercial }