Invoke Windows Service Action
This page has been generated from the NinjaOne PowerShell module source. To make changes please edit the appropriate PowerShell source file.
SYNOPSIS
Runs an action against the given Windows Service for the given device.
SYNTAX
Invoke-NinjaOneWindowsServiceAction [-deviceId] <Int32> [-serviceId] <String> [-action] <String>
[-ProgressAction <ActionPreference>] [-WhatIf] [-Confirm] [<CommonParameters>]
DESCRIPTION
Runs an action against a windows service on a single device using the NinjaOne v2 API.
EXAMPLES
EXAMPLE 1
PARAMETERS
-deviceId
The device(s) to change service configuration for.
Type: Int32
Parameter Sets: (All)
Aliases: id
Required: True
Position: 1
Default value: 0
Accept pipeline input: True (ByPropertyName, ByValue)
Accept wildcard characters: False
-serviceId
The service to alter configuration for.
Type: String
Parameter Sets: (All)
Aliases: service, serviceName
Required: True
Position: 2
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-action
The action to invoke.
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 3
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
OUTPUTS
System.Void
This commandlet returns no output. A success message will be written to the information stream if the API returns a 204 success code. Use -InformationAction Continue
to see this message.
NOTES
RELATED LINKS
https://docs.homotechsual.dev/modules/ninjaone/commandlets/Invoke/windowsserviceaction