Files
PSOPNSenseAPI/docs/cmdlets/Start-OPNSenseService.md
T

2.2 KiB

Start-OPNSenseService

SYNOPSIS

Starts a service on an OPNSense firewall.

SYNTAX

Start-OPNSenseService -Name <String> [-WhatIf] [-Confirm]

DESCRIPTION

The Start-OPNSenseService cmdlet starts a service on an OPNSense firewall.

EXAMPLES

Example 1: Start a service

Start-OPNSenseService -Name "dhcpd"

This example starts the DHCP service on the OPNSense firewall.

Example 2: Start a service with confirmation

Start-OPNSenseService -Name "unbound" -Confirm

This example prompts for confirmation before starting the DNS resolver service.

PARAMETERS

-Name

The name of the service to start.

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 service 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. Some services may require additional configuration before they can be started.

Get-OPNSenseService Stop-OPNSenseService Restart-OPNSenseService