Get‐OPNsensePackage - fvanroie/PS_OPNsense GitHub Wiki

Synopsis

Get a list of the packages in OPNsense

Syntax

Get-OPNsensePackage [[-Name] <String[]>] [-Installed] [-Locked] [<CommonParameters>]

Description

Retrieve a list of the packages in OPNsense.

Retrieve information about one or more packages in OPNsense.

Parameters

-Name   <String[]>

The name(s) of the packages to display.

Required? false
Position? 0
Default Value?
Pipeline Input? true (ByValue, ByPropertyName)

-Installed   <SwitchParameter>

Only list the packages that are installed on the OPNsense server. To return the packages that are not installed, specify -Installed:$false

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

-Locked   <SwitchParameter>

Only list the packages that have been locked. To return the packages that are unlocked, specify -Locked:$false

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

Examples

Get all available packages

Get-OPNsensePackage

Get packages with specific names

Get-OPNsensePackage -Name 'ac*','wol'

Get development packages that are installed and unlocked

Get-OPNsensePackage -Name '*-devel' -Installed -Locked:$false
⚠️ **GitHub.com Fallback** ⚠️