PSOPNSenseAPI/docs/cmdlets/Install-OPNSensePlugin.md

Install-OPNSensePlugin

SYNOPSIS

Installs a plugin on an OPNSense firewall.

SYNTAX

Install-OPNSensePlugin -Name <String> [-WhatIf] [-Confirm]

DESCRIPTION

The Install-OPNSensePlugin cmdlet installs a plugin on an OPNSense firewall.

EXAMPLES

Example 1: Install a plugin

Install-OPNSensePlugin -Name "os-acme-client"

This example installs the plugin with the name "os-acme-client" on the OPNSense firewall.

Example 2: Install a plugin with confirmation

Install-OPNSensePlugin -Name "os-theme-cicada" -Confirm

This example prompts for confirmation before installing the plugin.

PARAMETERS

-Name

The name of the plugin to install.

Type: String
Parameter Sets: (All)
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: wi

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Confirm

Prompts you for confirmation before running the cmdlet.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

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

System.String

You can pipe a string containing the plugin name to this cmdlet.

OUTPUTS

System.Object

Returns an object representing the result of the operation.

NOTES

This cmdlet requires a connection to an OPNSense firewall. Use Connect-OPNSense to establish a connection. Installing plugins may require a reboot of the firewall for the changes to take effect. Some plugins may have dependencies that need to be installed first.

RELATED LINKS

Get-OPNSensePlugin Uninstall-OPNSensePlugin Enable-OPNSensePlugin Disable-OPNSensePlugin