Device Maintenance

Generated Cmdlet Help

This page has been generated from the NinjaOne PowerShell module source. To make changes please edit the appropriate PowerShell source file.

SYNOPSIS

Sets a new maintenance window for the specified device(s)

SYNTAX

Set-NinjaOneDeviceMaintenance [-deviceId] <Int32> [-disabledFeatures] <String[]> [[-start] <DateTime>]
 [[-unixStart] <Int32>] [[-end] <DateTime>] [[-unixEnd] <Int32>] [-ProgressAction <ActionPreference>] [-WhatIf]
 [-Confirm] [<CommonParameters>]

DESCRIPTION

Schedule a new maintenance window for the given device(s) using the NinjaOne v2 API.

EXAMPLES

EXAMPLE 1

# FULL REQUEST EXAMPLE (AUTO-GENERATED) - BEGIN
PS> $body = @{
    disabledFeatures = @(
        "ALERTS"
    )
    reasonMessage = "string"
    end = 0
    start = 0
}
PS> Set-NinjaOneDeviceMaintenance -deviceId 1 -deviceId $body
# FULL REQUEST EXAMPLE (AUTO-GENERATED) - END

Full request example (auto-generated).

EXAMPLE 2

Set-NinjaOneDeviceMaintenance -Identity 123 -Property 'Value'

Updates the specified resource.

PARAMETERS

-deviceId

The device to set a maintenance window 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

-disabledFeatures

The features to disable during maintenance.

Type: String[]
Parameter Sets: (All)
Aliases:

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

-start

The start date/time for the maintenance window - PowerShell DateTime object.

Type: DateTime
Parameter Sets: (All)
Aliases:

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

-unixStart

The start date/time for the maintenance window - Unix Epoch time.

Type: Int32
Parameter Sets: (All)
Aliases:

Required: False
Position: 3
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False

-end

The end date/time for the maintenance window - PowerShell DateTime object.

Type: DateTime
Parameter Sets: (All)
Aliases:

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

-unixEnd

The end date/time for the maintenance window - Unix Epoch time.

Type: Int32
Parameter Sets: (All)
Aliases:

Required: False
Position: 4
Default value: 0
Accept pipeline input: False
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

A powershell object containing the response.

NOTES

RELATED LINKS

https://docs.homotechsual.dev/modules/ninjaone/commandlets/Set/devicemaintenance