PSOPNSenseAPI/docs/cmdlets/Disable-OPNSenseTailscale.md

Disable-OPNSenseTailscale

SYNOPSIS

Disables Tailscale on an OPNSense firewall.

SYNTAX

Disable-OPNSenseTailscale [-WhatIf] [-Confirm]

DESCRIPTION

The Disable-OPNSenseTailscale cmdlet disables the Tailscale service on an OPNSense firewall.

EXAMPLES

Example 1: Disable Tailscale

Disable-OPNSenseTailscale

This example disables the Tailscale service on the OPNSense firewall.

Example 2: Disable Tailscale with confirmation

Disable-OPNSenseTailscale -Confirm

This example prompts for confirmation before disabling the Tailscale service.

PARAMETERS

-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

None

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. The Tailscale plugin must be installed on the OPNSense firewall. Disabling Tailscale will disconnect the firewall from the Tailscale network.

RELATED LINKS

Enable-OPNSenseTailscale Get-OPNSenseTailscaleStatus Get-OPNSenseTailscaleConfig Set-OPNSenseTailscaleConfig Install-OPNSenseTailscale