mirror of
https://github.com/freedbygrace/PSOPNSenseAPI.git
synced 2026-07-26 11:58:18 +00:00
GraceSolutions
103 lines
2.5 KiB
Markdown
103 lines
2.5 KiB
Markdown
# Disable-OPNSensePlugin
|
|
|
|
## SYNOPSIS
|
|
Disables a plugin on an OPNSense firewall.
|
|
|
|
## SYNTAX
|
|
|
|
```
|
|
Disable-OPNSensePlugin -Name <String> [-WhatIf] [-Confirm]
|
|
```
|
|
|
|
## DESCRIPTION
|
|
The Disable-OPNSensePlugin cmdlet disables a plugin on an OPNSense firewall without uninstalling it.
|
|
|
|
## EXAMPLES
|
|
|
|
### Example 1: Disable a plugin
|
|
```powershell
|
|
Disable-OPNSensePlugin -Name "os-acme-client"
|
|
```
|
|
|
|
This example disables the plugin with the name "os-acme-client" on the OPNSense firewall.
|
|
|
|
### Example 2: Disable a plugin with confirmation
|
|
```powershell
|
|
Disable-OPNSensePlugin -Name "os-theme-cicada" -Confirm
|
|
```
|
|
|
|
This example prompts for confirmation before disabling the plugin.
|
|
|
|
## PARAMETERS
|
|
|
|
### -Name
|
|
The name of the plugin to disable.
|
|
|
|
```yaml
|
|
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.
|
|
|
|
```yaml
|
|
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.
|
|
|
|
```yaml
|
|
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](http://go.microsoft.com/fwlink/?LinkID=113216).
|
|
|
|
## 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.
|
|
Disabling a plugin does not remove it from the system, but prevents it from being used.
|
|
Disabling a plugin may require a reboot of the firewall for the changes to take effect.
|
|
Some plugins may have dependencies that need to be disabled first.
|
|
|
|
## RELATED LINKS
|
|
|
|
[Get-OPNSensePlugin](Get-OPNSensePlugin.md)
|
|
[Install-OPNSensePlugin](Install-OPNSensePlugin.md)
|
|
[Uninstall-OPNSensePlugin](Uninstall-OPNSensePlugin.md)
|
|
[Enable-OPNSensePlugin](Enable-OPNSensePlugin.md)
|