Backup

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 the bandwidth throttle for a device.

SYNTAX

Set-NinjaOneBackupBandwidthThrottle [-ThrottleSetting] <Object> [-ProgressAction <ActionPreference>] [-WhatIf]
 [-Confirm] [<CommonParameters>]

DESCRIPTION

Sets the bandwidth throttle for a device via the NinjaOne v2 API.

EXAMPLES

EXAMPLE 1

Set-NinjaOneBackupBandwidthThrottle -ThrottleSetting @{ deviceId = 1; bandwidthLimit = 5242880 }

Sets the bandwidth throttle for a device.

EXAMPLE 2

# FULL REQUEST EXAMPLE (AUTO-GENERATED) - BEGIN
 PS> $body = @{
	deviceId = 0
	bandwidthThrottle = @{
		enabled = $false
		workHoursKbps = 0
		nonWorkHoursKbps = 0
		workHoursUserUnit = "string"
		nonWorkHoursUserUnit = "string"
		workSchedule = @{
			endHour = 0
			endMinute = 0
			startHour = 0
			startMinute = 0
			weekDays = @(
				"string"
			)
		}
	}
}
PS> Set-NinjaOneBackupBandwidthThrottle -ThrottleSetting $body
# FULL REQUEST EXAMPLE (AUTO-GENERATED) - END

Full request example (auto-generated).

PARAMETERS

-ThrottleSetting

Bandwidth throttle setting payload per API schema

Type: Object
Parameter Sets: (All)
Aliases: body

Required: True
Position: 1
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

The API response indicating success or failure.

NOTES

RELATED LINKS

https://docs.homotechsual.dev/modules/ninjaone/commandlets/Set/backup-bandwidth-throttle