diff --git a/docset/winserver2025-ps/DeliveryOptimization/Delete-DeliveryOptimizationCache.md b/docset/winserver2025-ps/DeliveryOptimization/Delete-DeliveryOptimizationCache.md index d5099238e7..06767a9cea 100644 --- a/docset/winserver2025-ps/DeliveryOptimization/Delete-DeliveryOptimizationCache.md +++ b/docset/winserver2025-ps/DeliveryOptimization/Delete-DeliveryOptimizationCache.md @@ -1,7 +1,7 @@ --- external help file: DeliveryOptimizationSettings.psm1-help.xml Module Name: DeliveryOptimization -ms.date: 02/21/2024 +ms.date: 11/02/2026 online version: https://learn.microsoft.com/powershell/module/deliveryoptimization/delete-deliveryoptimizationcache?view=windowsserver2025-ps&wt.mc_id=ps-gethelp schema: 2.0.0 title: Delete-DeliveryOptimizationCache @@ -11,6 +11,8 @@ title: Delete-DeliveryOptimizationCache ## SYNOPSIS +Deletes files from the Delivery Optimization cache. + ## SYNTAX ``` @@ -20,23 +22,47 @@ Delete-DeliveryOptimizationCache [[-FileId] ] [-IncludePinnedFiles] [-Fo ## DESCRIPTION -{{ Fill in the Description }} +The `Delete-DeliveryOptimizationCache` cmdlet deletes cached Delivery Optimization files and +their associated persisted data. By default, pinned files aren't deleted. + +Use the **FileId** parameter to delete a specific file. If you omit **FileId**, the cmdlet +deletes all eligible files in the cache. Use **IncludePinnedFiles** to also delete pinned files. + +The cmdlet prompts before deleting files unless you specify **Force**. Deletion can't be undone. ## EXAMPLES -### Example 1 +### Example 1: Clear the cache without deleting pinned files + +```powershell +Delete-DeliveryOptimizationCache +``` + +This command prompts for confirmation, then deletes unpinned files from the cache. + +### Example 2: Delete a specific cached file + +```powershell +Delete-DeliveryOptimizationCache -FileId '0123456789abcdef0123456789abcdef' +``` + +This command prompts before deleting the specified file. Replace the example ID with a +**FileId** returned by `Get-DeliveryOptimizationStatus`. + +### Example 3: Delete all cached files, including pinned files ```powershell -PS C:\> {{ Add example code here }} +Delete-DeliveryOptimizationCache -IncludePinnedFiles -Force ``` -{{ Add example description here }} +This command deletes both pinned and unpinned files without prompting. ## PARAMETERS ### -FileId -{{ Fill FileId Description }} +Specifies the ID of the cached file to delete. Use `Get-DeliveryOptimizationStatus` to find +file IDs. If you omit this parameter, the cmdlet deletes all eligible cached files. ```yaml Type: System.String @@ -52,7 +78,8 @@ Accept wildcard characters: False ### -Force -{{ Fill Force Description }} +Deletes files without prompting for confirmation. This parameter doesn't allow deletion of +pinned files unless you also specify **IncludePinnedFiles**. ```yaml Type: System.Management.Automation.SwitchParameter @@ -68,7 +95,7 @@ Accept wildcard characters: False ### -IncludePinnedFiles -{{ Fill IncludePinnedFiles Description }} +Includes pinned files in the deletion. By default, the cmdlet preserves pinned files. ```yaml Type: System.Management.Automation.SwitchParameter @@ -91,10 +118,24 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS +### None + +You can't pipe objects to this cmdlet. + ## OUTPUTS +### None + +This cmdlet doesn't return objects. It displays deletion status messages in the console. + ## NOTES +Run this cmdlet from an elevated PowerShell session. + ## RELATED LINKS -[https://aka.ms/do-cmdlets](https://aka.ms/do-cmdlets) +[Get-DeliveryOptimizationStatus](Get-DeliveryOptimizationStatus.md) + +[Set-DeliveryOptimizationStatus](Set-DeliveryOptimizationStatus.md) + +[Monitor Delivery Optimization](https://learn.microsoft.com/windows/deployment/do/waas-delivery-optimization-monitor) diff --git a/docset/winserver2025-ps/DeliveryOptimization/DeliveryOptimization.md b/docset/winserver2025-ps/DeliveryOptimization/DeliveryOptimization.md index b2f092f63f..0cdd224c9a 100644 --- a/docset/winserver2025-ps/DeliveryOptimization/DeliveryOptimization.md +++ b/docset/winserver2025-ps/DeliveryOptimization/DeliveryOptimization.md @@ -4,66 +4,65 @@ Help Version: 5.1.0.2025 Locale: en-US Module Guid: b9af2675-4726-42fd-adab-38228176a516 Module Name: DeliveryOptimization -ms.date: 02/21/2024 +ms.date: 11/02/2026 title: DeliveryOptimization module --- # DeliveryOptimization Module ## Description -{{ Fill in the Description }} +Use the DeliveryOptimization cmdlets to monitor downloads and performance, configure download modes and bandwidth limits, manage cached files, and troubleshoot Delivery Optimization. ## DeliveryOptimization Cmdlets ### [Delete-DeliveryOptimizationCache](Delete-DeliveryOptimizationCache.md) -{{ Fill in the Description }} +Deletes files from the Delivery Optimization cache and removes their associated persisted data. ### [Disable-DeliveryOptimizationVerboseLogs](Disable-DeliveryOptimizationVerboseLogs.md) -{{ Fill in the Description }} +Disables verbose logging for Delivery Optimization. ### [Enable-DeliveryOptimizationVerboseLogs](Enable-DeliveryOptimizationVerboseLogs.md) -{{ Fill in the Description }} +Enables verbose logging for Delivery Optimization. ### [Get-DeliveryOptimizationPerfSnap](Get-DeliveryOptimizationPerfSnap.md) -{{ Fill in the Description }} +Gets a snapshot of Delivery Optimization performance statistics. ### [Get-DeliveryOptimizationPerfSnapThisMonth](Get-DeliveryOptimizationPerfSnapThisMonth.md) -{{ Fill in the Description }} +Gets Delivery Optimization performance statistics for the current calendar month. ### [Get-DeliveryOptimizationStatus](Get-DeliveryOptimizationStatus.md) -{{ Fill in the Description }} +Gets a real-time snapshot of current Delivery Optimization jobs. ### [Get-DOConfig](Get-DOConfig.md) -{{ Fill in the Description }} +Gets the local configuration and policies applied to Delivery Optimization. ### [Get-DODownloadMode](Get-DODownloadMode.md) -{{ Fill in the Description }} +Gets the current Delivery Optimization download mode. ### [Get-DOPercentageMaxBackgroundBandwidth](Get-DOPercentageMaxBackgroundBandwidth.md) -{{ Fill in the Description }} +Gets the maximum percentage of available bandwidth that Delivery Optimization can use for background downloads. ### [Get-DOPercentageMaxForegroundBandwidth](Get-DOPercentageMaxForegroundBandwidth.md) -{{ Fill in the Description }} +Gets the maximum percentage of available bandwidth that Delivery Optimization can use for foreground downloads. ### [Set-DeliveryOptimizationStatus](Set-DeliveryOptimizationStatus.md) -{{ Fill in the Description }} +Sets the expiration time or pinning status of files in the Delivery Optimization cache. ### [Set-DODownloadMode](Set-DODownloadMode.md) -{{ Fill in the Description }} +Sets the Delivery Optimization download mode. ### [Set-DOMaxBackgroundBandwidth](Set-DOMaxBackgroundBandwidth.md) -{{ Fill in the Description }} +Sets the maximum bandwidth, in KB/s, that Delivery Optimization can use for background downloads. ### [Set-DOMaxForegroundBandwidth](Set-DOMaxForegroundBandwidth.md) -{{ Fill in the Description }} +Sets the maximum bandwidth, in KB/s, that Delivery Optimization can use for foreground downloads. ### [Set-DOPercentageMaxBackgroundBandwidth](Set-DOPercentageMaxBackgroundBandwidth.md) -{{ Fill in the Description }} +Sets the maximum percentage of available bandwidth that Delivery Optimization can use for background downloads. ### [Set-DOPercentageMaxForegroundBandwidth](Set-DOPercentageMaxForegroundBandwidth.md) -{{ Fill in the Description }} +Sets the maximum percentage of available bandwidth that Delivery Optimization can use for foreground downloads. ### [Get-DeliveryOptimizationLog](Get-DeliveryOptimizationLog.md) -{{ Fill in the Description }} +Gets Delivery Optimization log entries as PowerShell objects. ### [Get-DeliveryOptimizationLogAnalysis](Get-DeliveryOptimizationLogAnalysis.md) -{{ Fill in the Description }} - +Analyzes Delivery Optimization logs to summarize download activity and peering efficiency. diff --git a/docset/winserver2025-ps/DeliveryOptimization/Disable-DeliveryOptimizationVerboseLogs.md b/docset/winserver2025-ps/DeliveryOptimization/Disable-DeliveryOptimizationVerboseLogs.md index dc90313f71..2c35b6e0ef 100644 --- a/docset/winserver2025-ps/DeliveryOptimization/Disable-DeliveryOptimizationVerboseLogs.md +++ b/docset/winserver2025-ps/DeliveryOptimization/Disable-DeliveryOptimizationVerboseLogs.md @@ -1,7 +1,7 @@ --- external help file: DeliveryOptimizationVerboseLogs.psm1-help.xml Module Name: DeliveryOptimization -ms.date: 02/21/2024 +ms.date: 11/02/2026 online version: https://learn.microsoft.com/powershell/module/deliveryoptimization/disable-deliveryoptimizationverboselogs?view=windowsserver2025-ps&wt.mc_id=ps-gethelp schema: 2.0.0 title: Disable-DeliveryOptimizationVerboseLogs @@ -11,6 +11,8 @@ title: Disable-DeliveryOptimizationVerboseLogs ## SYNOPSIS +Disables verbose logging for Delivery Optimization. + ## SYNTAX ``` @@ -19,23 +21,38 @@ Disable-DeliveryOptimizationVerboseLogs [-Force] [] ## DESCRIPTION -{{ Fill in the Description }} +The `Disable-DeliveryOptimizationVerboseLogs` cmdlet removes the verbose tracing configuration +and log size overrides set by `Enable-DeliveryOptimizationVerboseLogs`. + +If the Delivery Optimization service is running, the cmdlet prompts to restart it so the changes +take effect. Restarting the service interrupts active downloads. If you decline the restart, +the changes take effect the next time the service starts. ## EXAMPLES -### Example 1 +### Example 1: Disable verbose logging + +```powershell +Disable-DeliveryOptimizationVerboseLogs +``` + +This command disables verbose logging and prompts to restart the service if it's running. + +### Example 2: Disable verbose logging without a restart prompt ```powershell -PS C:\> {{ Add example code here }} +Disable-DeliveryOptimizationVerboseLogs -Force ``` -{{ Add example description here }} +This command disables verbose logging and restarts the running service without prompting. +The restart interrupts active downloads. ## PARAMETERS ### -Force -{{ Fill Force Description }} +Restarts the Delivery Optimization service without prompting if it's running, so the logging +changes take effect immediately. The restart interrupts active downloads. ```yaml Type: System.Management.Automation.SwitchParameter @@ -58,10 +75,24 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS +### None + +You can't pipe objects to this cmdlet. + ## OUTPUTS +### None + +This cmdlet doesn't return objects. It displays logging configuration status in the console. + ## NOTES +Run this cmdlet from an elevated PowerShell session. + ## RELATED LINKS -[https://aka.ms/do-cmdlets](https://aka.ms/do-cmdlets) +[Enable-DeliveryOptimizationVerboseLogs](Enable-DeliveryOptimizationVerboseLogs.md) + +[Get-DeliveryOptimizationLog](Get-DeliveryOptimizationLog.md) + +[Monitor Delivery Optimization](https://learn.microsoft.com/windows/deployment/do/waas-delivery-optimization-monitor) diff --git a/docset/winserver2025-ps/DeliveryOptimization/Enable-DeliveryOptimizationVerboseLogs.md b/docset/winserver2025-ps/DeliveryOptimization/Enable-DeliveryOptimizationVerboseLogs.md index 4cd8f45e98..bb8b8ed2ae 100644 --- a/docset/winserver2025-ps/DeliveryOptimization/Enable-DeliveryOptimizationVerboseLogs.md +++ b/docset/winserver2025-ps/DeliveryOptimization/Enable-DeliveryOptimizationVerboseLogs.md @@ -1,7 +1,7 @@ --- external help file: DeliveryOptimizationVerboseLogs.psm1-help.xml Module Name: DeliveryOptimization -ms.date: 02/21/2024 +ms.date: 11/02/2026 online version: https://learn.microsoft.com/powershell/module/deliveryoptimization/enable-deliveryoptimizationverboselogs?view=windowsserver2025-ps&wt.mc_id=ps-gethelp schema: 2.0.0 title: Enable-DeliveryOptimizationVerboseLogs @@ -11,6 +11,8 @@ title: Enable-DeliveryOptimizationVerboseLogs ## SYNOPSIS +Enables verbose logging for Delivery Optimization. + ## SYNTAX ``` @@ -19,23 +21,40 @@ Enable-DeliveryOptimizationVerboseLogs [-Force] [] ## DESCRIPTION -{{ Fill in the Description }} +The `Enable-DeliveryOptimizationVerboseLogs` cmdlet enables verbose Delivery Optimization +tracing and increases the log file and log folder size limits for troubleshooting. + +If the Delivery Optimization service is running, the cmdlet prompts to restart it so the changes +take effect. Restarting the service interrupts active downloads. If you decline the restart, +the changes take effect the next time the service starts. + +Use `Disable-DeliveryOptimizationVerboseLogs` when you finish collecting diagnostic logs. ## EXAMPLES -### Example 1 +### Example 1: Enable verbose logging + +```powershell +Enable-DeliveryOptimizationVerboseLogs +``` + +This command enables verbose logging and prompts to restart the service if it's running. + +### Example 2: Enable verbose logging without a restart prompt ```powershell -PS C:\> {{ Add example code here }} +Enable-DeliveryOptimizationVerboseLogs -Force ``` -{{ Add example description here }} +This command enables verbose logging and restarts the running service without prompting. +The restart interrupts active downloads. ## PARAMETERS ### -Force -{{ Fill Force Description }} +Restarts the Delivery Optimization service without prompting if it's running, so the logging +changes take effect immediately. The restart interrupts active downloads. ```yaml Type: System.Management.Automation.SwitchParameter @@ -58,10 +77,25 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS +### None + +You can't pipe objects to this cmdlet. + ## OUTPUTS +### None + +This cmdlet doesn't return objects. It displays logging configuration status in the console. + ## NOTES +Run this cmdlet from an elevated PowerShell session. Verbose logging generates additional +diagnostic data and uses more disk space than normal logging. + ## RELATED LINKS -[https://aka.ms/do-cmdlets](https://aka.ms/do-cmdlets) +[Disable-DeliveryOptimizationVerboseLogs](Disable-DeliveryOptimizationVerboseLogs.md) + +[Get-DeliveryOptimizationLog](Get-DeliveryOptimizationLog.md) + +[Monitor Delivery Optimization](https://learn.microsoft.com/windows/deployment/do/waas-delivery-optimization-monitor) diff --git a/docset/winserver2025-ps/DeliveryOptimization/Get-DOConfig.md b/docset/winserver2025-ps/DeliveryOptimization/Get-DOConfig.md index 28ae054514..ee8dbcaaa5 100644 --- a/docset/winserver2025-ps/DeliveryOptimization/Get-DOConfig.md +++ b/docset/winserver2025-ps/DeliveryOptimization/Get-DOConfig.md @@ -1,7 +1,7 @@ --- external help file: DeliveryOptimizationStatus.psm1-help.xml Module Name: DeliveryOptimization -ms.date: 02/21/2024 +ms.date: 11/02/2026 online version: https://learn.microsoft.com/powershell/module/deliveryoptimization/get-doconfig?view=windowsserver2025-ps&wt.mc_id=ps-gethelp schema: 2.0.0 title: Get-DOConfig @@ -11,6 +11,8 @@ title: Get-DOConfig ## SYNOPSIS +Gets the local configuration and policies applied to Delivery Optimization. + ## SYNTAX ``` @@ -19,17 +21,31 @@ Get-DOConfig [] ## DESCRIPTION -{{ Fill in the Description }} +The `Get-DOConfig` cmdlet returns Delivery Optimization configuration values and the provider +that supplies each value. Providers can include Group Policy, mobile device management (MDM), +Windows Settings, administrative configuration, and platform defaults. + +The default output includes the download mode and bandwidth limits. Use the **Verbose** common +parameter to return extended configuration, including cache location, device resource requirements, +VPN settings, and scheduled bandwidth restrictions. ## EXAMPLES -### Example 1 +### Example 1: Get the current configuration + +```powershell +Get-DOConfig +``` + +This command returns the basic Delivery Optimization configuration and the provider for each value. + +### Example 2: Get extended configuration ```powershell -PS C:\> {{ Add example code here }} +Get-DOConfig -Verbose ``` -{{ Add example description here }} +This command returns extended configuration values in addition to the basic configuration. ## PARAMETERS @@ -42,14 +58,29 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS +### None + +You can't pipe objects to this cmdlet. + ## OUTPUTS ### DOConfig +Basic configuration values and their providers, returned by default. + ### DOExtendedConfig +Basic and extended configuration values and their providers, returned when verbose output is enabled. + ## NOTES +Use the provider properties to identify whether a value comes from policy or another configuration +source. `DefaultProvider` indicates a Delivery Optimization platform default. + ## RELATED LINKS -[https://aka.ms/do-cmdlets](https://aka.ms/do-cmdlets) +[Get-DODownloadMode](Get-DODownloadMode.md) + +[Set-DODownloadMode](Set-DODownloadMode.md) + +[Monitor Delivery Optimization](https://learn.microsoft.com/windows/deployment/do/waas-delivery-optimization-monitor) diff --git a/docset/winserver2025-ps/DeliveryOptimization/Get-DODownloadMode.md b/docset/winserver2025-ps/DeliveryOptimization/Get-DODownloadMode.md index 85e4a30b36..bf2ff185fe 100644 --- a/docset/winserver2025-ps/DeliveryOptimization/Get-DODownloadMode.md +++ b/docset/winserver2025-ps/DeliveryOptimization/Get-DODownloadMode.md @@ -1,7 +1,7 @@ --- external help file: DeliveryOptimizationStatus.psm1-help.xml Module Name: DeliveryOptimization -ms.date: 02/21/2024 +ms.date: 11/02/2026 online version: https://learn.microsoft.com/powershell/module/deliveryoptimization/get-dodownloadmode?view=windowsserver2025-ps&wt.mc_id=ps-gethelp schema: 2.0.0 title: Get-DODownloadMode @@ -11,6 +11,8 @@ title: Get-DODownloadMode ## SYNOPSIS +Gets the current Delivery Optimization download mode. + ## SYNTAX ``` @@ -19,17 +21,22 @@ Get-DODownloadMode [] ## DESCRIPTION -{{ Fill in the Description }} +The `Get-DODownloadMode` cmdlet returns the currently active Delivery Optimization download +mode on the local device. The mode controls which download sources and peer discovery +options Delivery Optimization uses. + +Use `Get-DOConfig` to also see the configuration provider that supplies the download mode. ## EXAMPLES -### Example 1 +### Example 1: Get the active download mode ```powershell -PS C:\> {{ Add example code here }} +Get-DODownloadMode ``` -{{ Add example description here }} +This command returns the active download mode, such as `CdnOnly`, `Lan`, `Group`, `Internet`, +or `Simple`. ## PARAMETERS @@ -42,11 +49,25 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS +### None + +You can't pipe objects to this cmdlet. + ## OUTPUTS ### DownloadMode + +An enumeration value that identifies the active download mode. + ## NOTES +The modes that this cmdlet can report aren't limited to the modes accepted by `Set-DODownloadMode`. +A mode can also be configured through Group Policy or MDM. + ## RELATED LINKS -[https://aka.ms/do-cmdlets](https://aka.ms/do-cmdlets) +[Set-DODownloadMode](Set-DODownloadMode.md) + +[Get-DOConfig](Get-DOConfig.md) + +[Monitor Delivery Optimization](https://learn.microsoft.com/windows/deployment/do/waas-delivery-optimization-monitor) diff --git a/docset/winserver2025-ps/DeliveryOptimization/Get-DOPercentageMaxBackgroundBandwidth.md b/docset/winserver2025-ps/DeliveryOptimization/Get-DOPercentageMaxBackgroundBandwidth.md index fc110cb85d..85aa4d246b 100644 --- a/docset/winserver2025-ps/DeliveryOptimization/Get-DOPercentageMaxBackgroundBandwidth.md +++ b/docset/winserver2025-ps/DeliveryOptimization/Get-DOPercentageMaxBackgroundBandwidth.md @@ -1,7 +1,7 @@ --- external help file: DeliveryOptimizationStatus.psm1-help.xml Module Name: DeliveryOptimization -ms.date: 02/21/2024 +ms.date: 11/02/2026 online version: https://learn.microsoft.com/powershell/module/deliveryoptimization/get-dopercentagemaxbackgroundbandwidth?view=windowsserver2025-ps&wt.mc_id=ps-gethelp schema: 2.0.0 title: Get-DOPercentageMaxBackgroundBandwidth @@ -11,6 +11,8 @@ title: Get-DOPercentageMaxBackgroundBandwidth ## SYNOPSIS +Gets the maximum bandwidth percentage for Delivery Optimization background downloads. + ## SYNTAX ``` @@ -18,17 +20,22 @@ Get-DOPercentageMaxBackgroundBandwidth [] ``` ## DESCRIPTION -{{ Fill in the Description }} + +The `Get-DOPercentageMaxBackgroundBandwidth` cmdlet returns the current maximum percentage +of available bandwidth that Delivery Optimization can use for background downloads. + +The returned value is a percentage, not an absolute transfer rate. Use `Get-DOConfig` to inspect +bandwidth configuration values and their providers. ## EXAMPLES -### Example 1 +### Example 1: Get the background bandwidth percentage ```powershell -PS C:\> {{ Add example code here }} +Get-DOPercentageMaxBackgroundBandwidth ``` -{{ Add example description here }} +This command returns the configured maximum background download bandwidth percentage. ## PARAMETERS @@ -41,12 +48,25 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS +### None + +You can't pipe objects to this cmdlet. + ## OUTPUTS ### System.Byte +The maximum background download bandwidth percentage. + ## NOTES +This cmdlet reports the percentage setting. Absolute bandwidth limits and other applicable +policies can also affect the bandwidth used by downloads. + ## RELATED LINKS -[https://aka.ms/do-cmdlets](https://aka.ms/do-cmdlets) +[Set-DOPercentageMaxBackgroundBandwidth](Set-DOPercentageMaxBackgroundBandwidth.md) + +[Get-DOPercentageMaxForegroundBandwidth](Get-DOPercentageMaxForegroundBandwidth.md) + +[Get-DOConfig](Get-DOConfig.md) diff --git a/docset/winserver2025-ps/DeliveryOptimization/Get-DOPercentageMaxForegroundBandwidth.md b/docset/winserver2025-ps/DeliveryOptimization/Get-DOPercentageMaxForegroundBandwidth.md index 77356a3b61..21ebe2f01b 100644 --- a/docset/winserver2025-ps/DeliveryOptimization/Get-DOPercentageMaxForegroundBandwidth.md +++ b/docset/winserver2025-ps/DeliveryOptimization/Get-DOPercentageMaxForegroundBandwidth.md @@ -1,7 +1,7 @@ --- external help file: DeliveryOptimizationStatus.psm1-help.xml Module Name: DeliveryOptimization -ms.date: 02/21/2024 +ms.date: 11/02/2026 online version: https://learn.microsoft.com/powershell/module/deliveryoptimization/get-dopercentagemaxforegroundbandwidth?view=windowsserver2025-ps&wt.mc_id=ps-gethelp schema: 2.0.0 title: Get-DOPercentageMaxForegroundBandwidth @@ -11,6 +11,8 @@ title: Get-DOPercentageMaxForegroundBandwidth ## SYNOPSIS +Gets the maximum bandwidth percentage for Delivery Optimization foreground downloads. + ## SYNTAX ``` @@ -18,30 +20,53 @@ Get-DOPercentageMaxForegroundBandwidth [] ``` ## DESCRIPTION -{{ Fill in the Description }} + +The `Get-DOPercentageMaxForegroundBandwidth` cmdlet returns the current maximum percentage +of available bandwidth that Delivery Optimization can use for foreground downloads. + +The returned value is a percentage, not an absolute transfer rate. Use `Get-DOConfig` to inspect +bandwidth configuration values and their providers. ## EXAMPLES -### Example 1 +### Example 1: Get the foreground bandwidth percentage + ```powershell -PS C:\> {{ Add example code here }} +Get-DOPercentageMaxForegroundBandwidth ``` -{{ Add example description here }} +This command returns the configured maximum foreground download bandwidth percentage. ## PARAMETERS ### 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](http://go.microsoft.com/fwlink/?LinkID=113216). + +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, +-InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, +-WarningAction, and -WarningVariable. For more information, see +[about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS +### None + +You can't pipe objects to this cmdlet. + ## OUTPUTS ### System.Byte + +The maximum foreground download bandwidth percentage. + ## NOTES +This cmdlet reports the percentage setting. Absolute bandwidth limits and other applicable +policies can also affect the bandwidth used by downloads. + ## RELATED LINKS -[https://aka.ms/do-cmdlets](https://aka.ms/do-cmdlets) +[Set-DOPercentageMaxForegroundBandwidth](Set-DOPercentageMaxForegroundBandwidth.md) + +[Get-DOPercentageMaxBackgroundBandwidth](Get-DOPercentageMaxBackgroundBandwidth.md) +[Get-DOConfig](Get-DOConfig.md) diff --git a/docset/winserver2025-ps/DeliveryOptimization/Get-DeliveryOptimizationLog.md b/docset/winserver2025-ps/DeliveryOptimization/Get-DeliveryOptimizationLog.md index 9a9af78f6a..6a6808fd29 100644 --- a/docset/winserver2025-ps/DeliveryOptimization/Get-DeliveryOptimizationLog.md +++ b/docset/winserver2025-ps/DeliveryOptimization/Get-DeliveryOptimizationLog.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Windows.DeliveryOptimization.AdminCommands.dll-Help.xml Module Name: DeliveryOptimization -ms.date: 02/21/2024 +ms.date: 11/02/2026 online version: https://learn.microsoft.com/powershell/module/deliveryoptimization/get-deliveryoptimizationlog?view=windowsserver2025-ps&wt.mc_id=ps-gethelp schema: 2.0.0 title: Get-DeliveryOptimizationLog @@ -10,7 +10,8 @@ title: Get-DeliveryOptimizationLog # Get-DeliveryOptimizationLog ## SYNOPSIS -{{ Fill in the Synopsis }} + +Gets Delivery Optimization trace log entries as PowerShell objects. ## SYNTAX @@ -21,23 +22,49 @@ Get-DeliveryOptimizationLog [-LevelFilter ] [-Provider ] [ ## DESCRIPTION -{{ Fill in the Description }} +The `Get-DeliveryOptimizationLog` cmdlet reads Delivery Optimization event trace log (ETL) +files and writes the log entries to the PowerShell pipeline as objects. + +Use **Path** to read saved ETL files. If you omit **Path**, the cmdlet reads logs from the +Delivery Optimization service log directory, which requires administrator permissions. + +Use **Flush** to flush buffered trace data before reading logs. This stops the Delivery +Optimization service and can interrupt active downloads. ## EXAMPLES -### Example 1 +### Example 1: Read the local Delivery Optimization logs + +```powershell +Get-DeliveryOptimizationLog +``` + +This command reads the default service log directory. Run it from an elevated PowerShell session. + +### Example 2: Read a saved trace file + +```powershell +Get-DeliveryOptimizationLog -Path 'C:\Logs\DeliveryOptimization.etl' +``` + +This command converts entries in the specified ETL file to PowerShell objects. + +### Example 3: Export the latest logs to a text file ```powershell -PS C:\> {{ Add example code here }} +Get-DeliveryOptimizationLog -Flush | Set-Content -Path 'C:\Logs\DeliveryOptimization.txt' ``` -{{ Add example description here }} +This command flushes the logs and saves the log entries as text. The destination directory +must already exist. Flushing stops the service and can interrupt downloads. ## PARAMETERS ### -Flush -{{ Fill Flush Description }} +Flushes buffered Delivery Optimization trace data before reading the logs. This stops the +Delivery Optimization service and can interrupt active downloads. Run with administrator +permissions. ```yaml Type: System.Management.Automation.SwitchParameter @@ -53,7 +80,7 @@ Accept wildcard characters: False ### -LevelFilter -{{ Fill LevelFilter Description }} +Specifies the numeric event trace level filter to apply when reading log entries. ```yaml Type: System.UInt32 @@ -69,7 +96,9 @@ Accept wildcard characters: False ### -Path -{{ Fill Path Description }} +Specifies one or more ETL file paths to read. If you omit this parameter, the cmdlet reads +the Delivery Optimization service log directory. You can pipe paths to this parameter or +provide objects with a **Path** or **PSPath** property. ```yaml Type: System.String[] @@ -85,7 +114,8 @@ Accept wildcard characters: False ### -Provider -{{ Fill Provider Description }} +Specifies the Delivery Optimization trace provider to read. The accepted values are `Dosvc` +for the Delivery Optimization service provider and `Domgmt` for the management provider. ```yaml Type: Microsoft.Windows.DeliveryOptimization.AdminCommands.ProviderType @@ -111,10 +141,25 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ### System.String[] +You can pipe ETL file paths to this cmdlet. + ## OUTPUTS ### Microsoft.Windows.DeliveryOptimization.AdminCommands.LogOutput +Delivery Optimization trace log entries. + ## NOTES +Reading the default service logs or using **Flush** requires an elevated PowerShell session. +Use `Get-DeliveryOptimizationLogAnalysis` to summarize download and peering activity. + ## RELATED LINKS + +[Get-DeliveryOptimizationLogAnalysis](Get-DeliveryOptimizationLogAnalysis.md) + +[Enable-DeliveryOptimizationVerboseLogs](Enable-DeliveryOptimizationVerboseLogs.md) + +[Disable-DeliveryOptimizationVerboseLogs](Disable-DeliveryOptimizationVerboseLogs.md) + +[Monitor Delivery Optimization](https://learn.microsoft.com/windows/deployment/do/waas-delivery-optimization-monitor) diff --git a/docset/winserver2025-ps/DeliveryOptimization/Get-DeliveryOptimizationLogAnalysis.md b/docset/winserver2025-ps/DeliveryOptimization/Get-DeliveryOptimizationLogAnalysis.md index dbda00d2e7..4a8eb10b4c 100644 --- a/docset/winserver2025-ps/DeliveryOptimization/Get-DeliveryOptimizationLogAnalysis.md +++ b/docset/winserver2025-ps/DeliveryOptimization/Get-DeliveryOptimizationLogAnalysis.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Windows.DeliveryOptimization.AdminCommands.dll-Help.xml Module Name: DeliveryOptimization -ms.date: 02/21/2024 +ms.date: 11/02/2026 online version: https://learn.microsoft.com/powershell/module/deliveryoptimization/get-deliveryoptimizationloganalysis?view=windowsserver2025-ps&wt.mc_id=ps-gethelp schema: 2.0.0 title: Get-DeliveryOptimizationLogAnalysis @@ -10,7 +10,8 @@ title: Get-DeliveryOptimizationLogAnalysis # Get-DeliveryOptimizationLogAnalysis ## SYNOPSIS -{{ Fill in the Synopsis }} + +Analyzes Delivery Optimization logs to summarize downloads and peering efficiency. ## SYNTAX @@ -20,23 +21,43 @@ Get-DeliveryOptimizationLogAnalysis [-ListConnections] [[-Path] ] [-Fl ## DESCRIPTION -{{ Fill in the Description }} +The `Get-DeliveryOptimizationLogAnalysis` cmdlet analyzes Delivery Optimization ETL files. +By default, it summarizes file counts, foreground downloads, files eligible for peering, +files that found or downloaded from peers, and overall and peer-assisted download efficiency. + +Use **ListConnections** to get connection details, including peer address, peer type, status +code, bytes sent and received, and file ID. + +Use **Path** to analyze saved ETL files. If you omit **Path**, the cmdlet reads the Delivery +Optimization service logs. For the latest trace data, run `Get-DeliveryOptimizationLog -Flush` +before analysis. Flushing stops the service and can interrupt active downloads. ## EXAMPLES -### Example 1 +### Example 1: Analyze the local Delivery Optimization logs + +```powershell +Get-DeliveryOptimizationLogAnalysis +``` + +This command summarizes download and peering activity in the default service logs. +Run it from an elevated PowerShell session. + +### Example 2: List connections from a saved trace ```powershell -PS C:\> {{ Add example code here }} +Get-DeliveryOptimizationLogAnalysis -Path 'C:\Logs\DeliveryOptimization.etl' -ListConnections ``` -{{ Add example description here }} +This command returns connection details from the specified ETL file. ## PARAMETERS ### -Flush -{{ Fill Flush Description }} +Flushes buffered Delivery Optimization trace data before analyzing the logs. This stops the +Delivery Optimization service and can interrupt active downloads. Run with administrator +permissions. ```yaml Type: System.Management.Automation.SwitchParameter @@ -52,7 +73,8 @@ Accept wildcard characters: False ### -ListConnections -{{ Fill ListConnections Description }} +Returns connection details instead of the default summary. Details include destination IP +address, peer type, status code, bytes sent and received, and file ID. ```yaml Type: System.Management.Automation.SwitchParameter @@ -68,7 +90,9 @@ Accept wildcard characters: False ### -Path -{{ Fill Path Description }} +Specifies one or more ETL file paths to analyze. If you omit this parameter, the cmdlet +analyzes the Delivery Optimization service logs. You can pipe paths to this parameter or +provide objects with a **Path** or **PSPath** property. ```yaml Type: System.String[] @@ -93,10 +117,23 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ### System.String[] +You can pipe ETL file paths to this cmdlet. + ## OUTPUTS ### Microsoft.Windows.DeliveryOptimization.AdminCommands.LogOutput +Analysis results summarizing download activity or listing connection details. + ## NOTES +Analysis can take several minutes. Reading the default service logs or using **Flush** +requires an elevated PowerShell session. + ## RELATED LINKS + +[Get-DeliveryOptimizationLog](Get-DeliveryOptimizationLog.md) + +[Enable-DeliveryOptimizationVerboseLogs](Enable-DeliveryOptimizationVerboseLogs.md) + +[Monitor Delivery Optimization](https://learn.microsoft.com/windows/deployment/do/waas-delivery-optimization-monitor) diff --git a/docset/winserver2025-ps/DeliveryOptimization/Get-DeliveryOptimizationPerfSnap.md b/docset/winserver2025-ps/DeliveryOptimization/Get-DeliveryOptimizationPerfSnap.md index b9fb6e3f80..961404039c 100644 --- a/docset/winserver2025-ps/DeliveryOptimization/Get-DeliveryOptimizationPerfSnap.md +++ b/docset/winserver2025-ps/DeliveryOptimization/Get-DeliveryOptimizationPerfSnap.md @@ -1,7 +1,7 @@ --- external help file: DeliveryOptimizationStatus.psm1-help.xml Module Name: DeliveryOptimization -ms.date: 02/21/2024 +ms.date: 11/02/2026 online version: https://learn.microsoft.com/powershell/module/deliveryoptimization/get-deliveryoptimizationperfsnap?view=windowsserver2025-ps&wt.mc_id=ps-gethelp schema: 2.0.0 title: Get-DeliveryOptimizationPerfSnap @@ -11,6 +11,8 @@ title: Get-DeliveryOptimizationPerfSnap ## SYNOPSIS +Gets a snapshot of Delivery Optimization performance statistics. + ## SYNTAX ``` @@ -19,17 +21,31 @@ Get-DeliveryOptimizationPerfSnap [] ## DESCRIPTION -{{ Fill in the Description }} +The `Get-DeliveryOptimizationPerfSnap` cmdlet returns a point-in-time view of Delivery +Optimization activity on the local device. + +The snapshot includes download and upload totals, file counts, cache and disk usage, CPU and +memory usage, peer and server connection counts, and bandwidth usage. Use +`Get-DeliveryOptimizationPerfSnapThisMonth` to get usage statistics for the current calendar month. ## EXAMPLES -### Example 1 +### Example 1: Get the current performance snapshot + +```powershell +Get-DeliveryOptimizationPerfSnap +``` + +This command returns the current Delivery Optimization performance statistics. + +### Example 2: Select cache and transfer statistics ```powershell -PS C:\> {{ Add example code here }} +Get-DeliveryOptimizationPerfSnap | + Select-Object Files, CacheSizeBytes, TotalBytesDownloaded, TotalBytesUploaded ``` -{{ Add example description here }} +This command displays the file count, cache size, and downloaded and uploaded byte totals. ## PARAMETERS @@ -42,12 +58,25 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS +### None + +You can't pipe objects to this cmdlet. + ## OUTPUTS ### DOPerfSnap +A performance snapshot containing Delivery Optimization activity and resource usage statistics. + ## NOTES +The returned values describe the device when the cmdlet runs. They aren't a continuous +performance trace or a historical monthly report. + ## RELATED LINKS -[https://aka.ms/do-cmdlets](https://aka.ms/do-cmdlets) +[Get-DeliveryOptimizationPerfSnapThisMonth](Get-DeliveryOptimizationPerfSnapThisMonth.md) + +[Get-DeliveryOptimizationStatus](Get-DeliveryOptimizationStatus.md) + +[Monitor Delivery Optimization](https://learn.microsoft.com/windows/deployment/do/waas-delivery-optimization-monitor) diff --git a/docset/winserver2025-ps/DeliveryOptimization/Get-DeliveryOptimizationPerfSnapThisMonth.md b/docset/winserver2025-ps/DeliveryOptimization/Get-DeliveryOptimizationPerfSnapThisMonth.md index c6e0590b6f..045b38b8a8 100644 --- a/docset/winserver2025-ps/DeliveryOptimization/Get-DeliveryOptimizationPerfSnapThisMonth.md +++ b/docset/winserver2025-ps/DeliveryOptimization/Get-DeliveryOptimizationPerfSnapThisMonth.md @@ -1,7 +1,7 @@ --- external help file: DeliveryOptimizationStatus.psm1-help.xml Module Name: DeliveryOptimization -ms.date: 02/21/2024 +ms.date: 11/02/2026 online version: https://learn.microsoft.com/powershell/module/deliveryoptimization/get-deliveryoptimizationperfsnapthismonth?view=windowsserver2025-ps&wt.mc_id=ps-gethelp schema: 2.0.0 title: Get-DeliveryOptimizationPerfSnapThisMonth @@ -11,6 +11,8 @@ title: Get-DeliveryOptimizationPerfSnapThisMonth ## SYNOPSIS +Gets Delivery Optimization performance statistics for the current calendar month. + ## SYNTAX ``` @@ -19,17 +21,32 @@ Get-DeliveryOptimizationPerfSnapThisMonth [] ## DESCRIPTION -{{ Fill in the Description }} +The `Get-DeliveryOptimizationPerfSnapThisMonth` cmdlet returns Delivery Optimization usage +statistics for the current calendar month on the local device. + +The statistics include bytes downloaded from HTTP sources, cache servers, LAN peers, and +internet peers, bytes uploaded to peers, foreground and background download rates, and the +start date of the reporting month. ## EXAMPLES -### Example 1 +### Example 1: Get this month's usage statistics ```powershell -PS C:\> {{ Add example code here }} +Get-DeliveryOptimizationPerfSnapThisMonth ``` -{{ Add example description here }} +This command returns Delivery Optimization usage statistics for the current calendar month. + +### Example 2: Compare download sources + +```powershell +Get-DeliveryOptimizationPerfSnapThisMonth | + Select-Object MonthStartDate, DownloadHttpBytes, DownloadLanBytes, DownloadInternetBytes +``` + +This command displays the reporting month's start date and bytes downloaded from HTTP, +LAN peers, and internet peers. ## PARAMETERS @@ -42,13 +59,23 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS +### None + +You can't pipe objects to this cmdlet. + ## OUTPUTS ### DOMonthlyPerfSnap +A monthly performance snapshot containing transfer totals, download rates, and the reporting +month's start date. + ## NOTES +The reporting period is the current calendar month, not the previous 30 days. + ## RELATED LINKS -[https://aka.ms/do-cmdlets](https://aka.ms/do-cmdlets) +[Get-DeliveryOptimizationPerfSnap](Get-DeliveryOptimizationPerfSnap.md) +[Monitor Delivery Optimization](https://learn.microsoft.com/windows/deployment/do/waas-delivery-optimization-monitor) diff --git a/docset/winserver2025-ps/DeliveryOptimization/Get-DeliveryOptimizationStatus.md b/docset/winserver2025-ps/DeliveryOptimization/Get-DeliveryOptimizationStatus.md index 6d988c1cd9..99c5c39337 100644 --- a/docset/winserver2025-ps/DeliveryOptimization/Get-DeliveryOptimizationStatus.md +++ b/docset/winserver2025-ps/DeliveryOptimization/Get-DeliveryOptimizationStatus.md @@ -1,7 +1,7 @@ --- external help file: DeliveryOptimizationStatus.psm1-help.xml Module Name: DeliveryOptimization -ms.date: 02/21/2024 +ms.date: 11/02/2026 online version: https://learn.microsoft.com/powershell/module/deliveryoptimization/get-deliveryoptimizationstatus?view=windowsserver2025-ps&wt.mc_id=ps-gethelp schema: 2.0.0 title: Get-DeliveryOptimizationStatus @@ -11,6 +11,8 @@ title: Get-DeliveryOptimizationStatus ## SYNOPSIS +Gets the current status of Delivery Optimization jobs and their peers. + ## SYNTAX ``` @@ -20,23 +22,39 @@ Get-DeliveryOptimizationStatus [-PeerInfo] [-AsObject] [-SelectPeerCount ## DESCRIPTION -{{ Fill in the Description }} +The `Get-DeliveryOptimizationStatus` cmdlet returns a real-time snapshot of Delivery Optimization +jobs on the local device. Each job includes its file ID, size, download status, priority, transfer +totals, download sources, cache expiration, and pinning status. + +Use **PeerInfo** to get per-file peer details, such as IP addresses, peer types, connection +status, and bytes sent and received. Use **AsObject** with **PeerInfo** to group those details +in an object for each file. ## EXAMPLES -### Example 1 +### Example 1: Get current job status ```powershell -PS C:\> {{ Add example code here }} +Get-DeliveryOptimizationStatus ``` -{{ Add example description here }} +This command returns status objects for current Delivery Optimization jobs. + +### Example 2: Get peer details as objects + +```powershell +Get-DeliveryOptimizationStatus -PeerInfo -AsObject -SelectPeerCount 10 +``` + +This command returns a file-level object for each job, with up to 10 peers in its **PeersInfo** +property. Peers are sorted by bytes received, from highest to lowest. ## PARAMETERS ### -AsObject -{{ Fill AsObject Description }} +Returns a file-level object containing **FileId** and **PeersInfo** properties instead of +writing file IDs and peer objects separately. Use this parameter with **PeerInfo**. ```yaml Type: System.Management.Automation.SwitchParameter @@ -52,7 +70,8 @@ Accept wildcard characters: False ### -PeerInfo -{{ Fill PeerInfo Description }} +Returns peer information for each file instead of the default job statistics. Peer information +includes IP address, peer type, connection status, and transfer statistics. ```yaml Type: System.Management.Automation.SwitchParameter @@ -68,7 +87,9 @@ Accept wildcard characters: False ### -SelectPeerCount -{{ Fill SelectPeerCount Description }} +Specifies the maximum number of peers to return for each file when you use **PeerInfo**. +Peers are sorted by bytes received, from highest to lowest. Specify a positive integer. +The default is `5`. ```yaml Type: System.Int32 @@ -91,18 +112,39 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS +### None + +You can't pipe objects to this cmdlet. + ## OUTPUTS ### DOSwarmStats +Job statistics returned when you don't specify **PeerInfo**. + ### DOFilePeerInfo +A file ID and its associated peer objects, returned with **PeerInfo** and **AsObject**. + ### System.String +A file ID written before its peer details when you use **PeerInfo** without **AsObject**. + ### DOPeerInfo +Individual peer details returned with **PeerInfo** when you don't specify **AsObject**. + ## NOTES +Use the **FileId** property when managing cached files with `Set-DeliveryOptimizationStatus` +or `Delete-DeliveryOptimizationCache`. + ## RELATED LINKS -[https://aka.ms/do-cmdlets](https://aka.ms/do-cmdlets) +[Get-DeliveryOptimizationPerfSnap](Get-DeliveryOptimizationPerfSnap.md) + +[Set-DeliveryOptimizationStatus](Set-DeliveryOptimizationStatus.md) + +[Delete-DeliveryOptimizationCache](Delete-DeliveryOptimizationCache.md) + +[Monitor Delivery Optimization](https://learn.microsoft.com/windows/deployment/do/waas-delivery-optimization-monitor) diff --git a/docset/winserver2025-ps/DeliveryOptimization/Set-DODownloadMode.md b/docset/winserver2025-ps/DeliveryOptimization/Set-DODownloadMode.md index ad7e987f60..2a5edb61a7 100644 --- a/docset/winserver2025-ps/DeliveryOptimization/Set-DODownloadMode.md +++ b/docset/winserver2025-ps/DeliveryOptimization/Set-DODownloadMode.md @@ -1,7 +1,7 @@ --- external help file: DeliveryOptimizationSettings.psm1-help.xml Module Name: DeliveryOptimization -ms.date: 02/21/2024 +ms.date: 11/02/2026 online version: https://learn.microsoft.com/powershell/module/deliveryoptimization/set-dodownloadmode?view=windowsserver2025-ps&wt.mc_id=ps-gethelp schema: 2.0.0 title: Set-DODownloadMode @@ -11,6 +11,8 @@ title: Set-DODownloadMode ## SYNOPSIS +Sets the Delivery Optimization download mode. + ## SYNTAX ``` @@ -19,23 +21,39 @@ Set-DODownloadMode [-downloadMode] [] ## DESCRIPTION -{{ Fill in the Description }} +The `Set-DODownloadMode` cmdlet sets the Delivery Optimization download mode on the local device. +The supported modes are `CdnOnly`, `Lan`, and `Internet`. + +The download mode controls whether Delivery Optimization uses HTTP sources only or also +exchanges content with peers. Group Policy or MDM policy can override changes made with this cmdlet. ## EXAMPLES -### Example 1 +### Example 1: Enable LAN peering + +```powershell +Set-DODownloadMode -downloadMode Lan +``` + +This command configures Delivery Optimization to use HTTP sources and peers on the local network. + +### Example 2: Disable peer-to-peer downloads ```powershell -PS C:\> {{ Add example code here }} +Set-DODownloadMode -downloadMode CdnOnly ``` -{{ Add example description here }} +This command configures HTTP-only downloads without peer-to-peer sharing. ## PARAMETERS ### -downloadMode -{{ Fill downloadMode Description }} +Specifies the download mode. The accepted values are: + +- `CdnOnly`: Uses HTTP sources without peer-to-peer sharing. +- `Lan`: Allows peer-to-peer sharing with devices on the local network. +- `Internet`: Allows peer-to-peer sharing with devices on the internet. ```yaml Type: SettableDownloadMode @@ -59,10 +77,25 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS +### None + +You can't pipe objects to this cmdlet. + ## OUTPUTS +### None + +This cmdlet doesn't return objects. + ## NOTES +Run this cmdlet from an elevated PowerShell session. Use `Get-DODownloadMode` to check the +active mode and `Get-DOConfig` to identify its configuration provider. + ## RELATED LINKS -[https://aka.ms/do-cmdlets](https://aka.ms/do-cmdlets) +[Get-DODownloadMode](Get-DODownloadMode.md) + +[Get-DOConfig](Get-DOConfig.md) + +[Monitor Delivery Optimization](https://learn.microsoft.com/windows/deployment/do/waas-delivery-optimization-monitor) diff --git a/docset/winserver2025-ps/DeliveryOptimization/Set-DOMaxBackgroundBandwidth.md b/docset/winserver2025-ps/DeliveryOptimization/Set-DOMaxBackgroundBandwidth.md index 0b409f0a8a..7f4fc0b509 100644 --- a/docset/winserver2025-ps/DeliveryOptimization/Set-DOMaxBackgroundBandwidth.md +++ b/docset/winserver2025-ps/DeliveryOptimization/Set-DOMaxBackgroundBandwidth.md @@ -1,7 +1,7 @@ --- external help file: DeliveryOptimizationSettings.psm1-help.xml Module Name: DeliveryOptimization -ms.date: 02/21/2024 +ms.date: 11/02/2026 online version: https://learn.microsoft.com/powershell/module/deliveryoptimization/set-domaxbackgroundbandwidth?view=windowsserver2025-ps&wt.mc_id=ps-gethelp schema: 2.0.0 title: Set-DOMaxBackgroundBandwidth @@ -11,6 +11,8 @@ title: Set-DOMaxBackgroundBandwidth ## SYNOPSIS +Sets the maximum bandwidth for Delivery Optimization background downloads. + ## SYNTAX ``` @@ -19,23 +21,39 @@ Set-DOMaxBackgroundBandwidth [[-MaxBackgroundBandwidth] ] [-Reset] [ {{ Add example code here }} +Set-DOMaxBackgroundBandwidth -Reset ``` -{{ Add example description here }} +This command removes the limit set by this cmdlet and restores dynamic bandwidth adjustment, +subject to applicable policies. ## PARAMETERS ### -MaxBackgroundBandwidth -{{ Fill MaxBackgroundBandwidth Description }} +Specifies the maximum background download bandwidth in KB/s. Specify this parameter or **Reset**, +but not both. ```yaml Type: System.Nullable`1[System.UInt32] @@ -51,7 +69,8 @@ Accept wildcard characters: False ### -Reset -{{ Fill Reset Description }} +Restores the default dynamic background download bandwidth adjustment. Don't specify +**MaxBackgroundBandwidth** with this parameter. ```yaml Type: System.Management.Automation.SwitchParameter @@ -74,10 +93,27 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS +### None + +You can't pipe objects to this cmdlet. + ## OUTPUTS +### None + +This cmdlet doesn't return objects. + ## NOTES +Run this cmdlet from an elevated PowerShell session. Use `Get-DOConfig` to inspect bandwidth +settings and their configuration providers. + ## RELATED LINKS -[https://aka.ms/do-cmdlets](https://aka.ms/do-cmdlets) +[Set-DOMaxForegroundBandwidth](Set-DOMaxForegroundBandwidth.md) + +[Set-DOPercentageMaxBackgroundBandwidth](Set-DOPercentageMaxBackgroundBandwidth.md) + +[Get-DOConfig](Get-DOConfig.md) + +[Monitor Delivery Optimization](https://learn.microsoft.com/windows/deployment/do/waas-delivery-optimization-monitor) diff --git a/docset/winserver2025-ps/DeliveryOptimization/Set-DOMaxForegroundBandwidth.md b/docset/winserver2025-ps/DeliveryOptimization/Set-DOMaxForegroundBandwidth.md index 2f67929252..ff45207d47 100644 --- a/docset/winserver2025-ps/DeliveryOptimization/Set-DOMaxForegroundBandwidth.md +++ b/docset/winserver2025-ps/DeliveryOptimization/Set-DOMaxForegroundBandwidth.md @@ -1,7 +1,7 @@ --- external help file: DeliveryOptimizationSettings.psm1-help.xml Module Name: DeliveryOptimization -ms.date: 02/21/2024 +ms.date: 11/02/2026 online version: https://learn.microsoft.com/powershell/module/deliveryoptimization/set-domaxforegroundbandwidth?view=windowsserver2025-ps&wt.mc_id=ps-gethelp schema: 2.0.0 title: Set-DOMaxForegroundBandwidth @@ -11,6 +11,8 @@ title: Set-DOMaxForegroundBandwidth ## SYNOPSIS +Sets the maximum bandwidth for Delivery Optimization foreground downloads. + ## SYNTAX ``` @@ -19,23 +21,39 @@ Set-DOMaxForegroundBandwidth [[-MaxForegroundBandwidth] ] [-Reset] [ {{ Add example code here }} +Set-DOMaxForegroundBandwidth -Reset ``` -{{ Add example description here }} +This command removes the limit set by this cmdlet and restores dynamic bandwidth adjustment, +subject to applicable policies. ## PARAMETERS ### -MaxForegroundBandwidth -{{ Fill MaxForegroundBandwidth Description }} +Specifies the maximum foreground download bandwidth in KB/s. Specify this parameter or **Reset**, +but not both. ```yaml Type: System.Nullable`1[System.UInt32] @@ -51,7 +69,8 @@ Accept wildcard characters: False ### -Reset -{{ Fill Reset Description }} +Restores the default dynamic foreground download bandwidth adjustment. Don't specify +**MaxForegroundBandwidth** with this parameter. ```yaml Type: System.Management.Automation.SwitchParameter @@ -74,10 +93,27 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS +### None + +You can't pipe objects to this cmdlet. + ## OUTPUTS +### None + +This cmdlet doesn't return objects. + ## NOTES +Run this cmdlet from an elevated PowerShell session. Use `Get-DOConfig` to inspect bandwidth +settings and their configuration providers. + ## RELATED LINKS -[https://aka.ms/do-cmdlets](https://aka.ms/do-cmdlets) +[Set-DOMaxBackgroundBandwidth](Set-DOMaxBackgroundBandwidth.md) + +[Set-DOPercentageMaxForegroundBandwidth](Set-DOPercentageMaxForegroundBandwidth.md) + +[Get-DOConfig](Get-DOConfig.md) + +[Monitor Delivery Optimization](https://learn.microsoft.com/windows/deployment/do/waas-delivery-optimization-monitor) diff --git a/docset/winserver2025-ps/DeliveryOptimization/Set-DOPercentageMaxBackgroundBandwidth.md b/docset/winserver2025-ps/DeliveryOptimization/Set-DOPercentageMaxBackgroundBandwidth.md index b4e59a3935..eddae0c5d2 100644 --- a/docset/winserver2025-ps/DeliveryOptimization/Set-DOPercentageMaxBackgroundBandwidth.md +++ b/docset/winserver2025-ps/DeliveryOptimization/Set-DOPercentageMaxBackgroundBandwidth.md @@ -1,7 +1,7 @@ --- external help file: DeliveryOptimizationSettings.psm1-help.xml Module Name: DeliveryOptimization -ms.date: 02/21/2024 +ms.date: 11/02/2026 online version: https://learn.microsoft.com/powershell/module/deliveryoptimization/set-dopercentagemaxbackgroundbandwidth?view=windowsserver2025-ps&wt.mc_id=ps-gethelp schema: 2.0.0 title: Set-DOPercentageMaxBackgroundBandwidth @@ -11,6 +11,8 @@ title: Set-DOPercentageMaxBackgroundBandwidth ## SYNOPSIS +Sets the maximum bandwidth percentage for Delivery Optimization background downloads. + ## SYNTAX ``` @@ -20,23 +22,39 @@ Set-DOPercentageMaxBackgroundBandwidth [[-MaxBackgroundBandwidthPercentage] {{ Add example code here }} +Set-DOPercentageMaxBackgroundBandwidth -Reset ``` -{{ Add example description here }} +This command restores the default background download bandwidth percentage, subject to +applicable policies. ## PARAMETERS ### -MaxBackgroundBandwidthPercentage -{{ Fill MaxBackgroundBandwidthPercentage Description }} +Specifies the maximum percentage of available bandwidth for background downloads. +Accepted values are `0` through `100`. Specify this parameter or **Reset**, but not both. ```yaml Type: System.Nullable`1[System.UInt32] @@ -52,7 +70,8 @@ Accept wildcard characters: False ### -Reset -{{ Fill Reset Description }} +Restores the default background download bandwidth percentage of 45 percent. Don't specify +**MaxBackgroundBandwidthPercentage** with this parameter. ```yaml Type: System.Management.Automation.SwitchParameter @@ -75,10 +94,28 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS +### None + +You can't pipe objects to this cmdlet. + ## OUTPUTS +### None + +This cmdlet doesn't return objects. + ## NOTES +Run this cmdlet from an elevated PowerShell session. Use +`Get-DOPercentageMaxBackgroundBandwidth` to check the percentage setting and `Get-DOConfig` to +inspect applicable configuration providers. + ## RELATED LINKS -[https://aka.ms/do-cmdlets](https://aka.ms/do-cmdlets) +[Get-DOPercentageMaxBackgroundBandwidth](Get-DOPercentageMaxBackgroundBandwidth.md) + +[Set-DOPercentageMaxForegroundBandwidth](Set-DOPercentageMaxForegroundBandwidth.md) + +[Set-DOMaxBackgroundBandwidth](Set-DOMaxBackgroundBandwidth.md) + +[Monitor Delivery Optimization](https://learn.microsoft.com/windows/deployment/do/waas-delivery-optimization-monitor) diff --git a/docset/winserver2025-ps/DeliveryOptimization/Set-DOPercentageMaxForegroundBandwidth.md b/docset/winserver2025-ps/DeliveryOptimization/Set-DOPercentageMaxForegroundBandwidth.md index 9feed9a78a..66d2b949da 100644 --- a/docset/winserver2025-ps/DeliveryOptimization/Set-DOPercentageMaxForegroundBandwidth.md +++ b/docset/winserver2025-ps/DeliveryOptimization/Set-DOPercentageMaxForegroundBandwidth.md @@ -1,7 +1,7 @@ --- external help file: DeliveryOptimizationSettings.psm1-help.xml Module Name: DeliveryOptimization -ms.date: 02/21/2024 +ms.date: 11/02/2026 online version: https://learn.microsoft.com/powershell/module/deliveryoptimization/set-dopercentagemaxforegroundbandwidth?view=windowsserver2025-ps&wt.mc_id=ps-gethelp schema: 2.0.0 title: Set-DOPercentageMaxForegroundBandwidth @@ -11,6 +11,8 @@ title: Set-DOPercentageMaxForegroundBandwidth ## SYNOPSIS +Sets the maximum bandwidth percentage for Delivery Optimization foreground downloads. + ## SYNTAX ``` @@ -20,23 +22,39 @@ Set-DOPercentageMaxForegroundBandwidth [[-MaxForegroundBandwidthPercentage] {{ Add example code here }} +Set-DOPercentageMaxForegroundBandwidth -Reset ``` -{{ Add example description here }} +This command restores the default foreground download bandwidth percentage, subject to +applicable policies. ## PARAMETERS ### -MaxForegroundBandwidthPercentage -{{ Fill MaxForegroundBandwidthPercentage Description }} +Specifies the maximum percentage of available bandwidth for foreground downloads. +Accepted values are `0` through `100`. Specify this parameter or **Reset**, but not both. ```yaml Type: System.Nullable`1[System.UInt32] @@ -52,7 +70,8 @@ Accept wildcard characters: False ### -Reset -{{ Fill Reset Description }} +Restores the default foreground download bandwidth percentage of 90 percent. Don't specify +**MaxForegroundBandwidthPercentage** with this parameter. ```yaml Type: System.Management.Automation.SwitchParameter @@ -75,10 +94,28 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS +### None + +You can't pipe objects to this cmdlet. + ## OUTPUTS +### None + +This cmdlet doesn't return objects. + ## NOTES +Run this cmdlet from an elevated PowerShell session. Use +`Get-DOPercentageMaxForegroundBandwidth` to check the percentage setting and `Get-DOConfig` to +inspect applicable configuration providers. + ## RELATED LINKS -[https://aka.ms/do-cmdlets](https://aka.ms/do-cmdlets) +[Get-DOPercentageMaxForegroundBandwidth](Get-DOPercentageMaxForegroundBandwidth.md) + +[Set-DOPercentageMaxBackgroundBandwidth](Set-DOPercentageMaxBackgroundBandwidth.md) + +[Set-DOMaxForegroundBandwidth](Set-DOMaxForegroundBandwidth.md) + +[Monitor Delivery Optimization](https://learn.microsoft.com/windows/deployment/do/waas-delivery-optimization-monitor) diff --git a/docset/winserver2025-ps/DeliveryOptimization/Set-DeliveryOptimizationStatus.md b/docset/winserver2025-ps/DeliveryOptimization/Set-DeliveryOptimizationStatus.md index a12a656351..437149f47d 100644 --- a/docset/winserver2025-ps/DeliveryOptimization/Set-DeliveryOptimizationStatus.md +++ b/docset/winserver2025-ps/DeliveryOptimization/Set-DeliveryOptimizationStatus.md @@ -1,7 +1,7 @@ --- external help file: DeliveryOptimizationSettings.psm1-help.xml Module Name: DeliveryOptimization -ms.date: 02/21/2024 +ms.date: 11/02/2026 online version: https://learn.microsoft.com/powershell/module/deliveryoptimization/set-deliveryoptimizationstatus?view=windowsserver2025-ps&wt.mc_id=ps-gethelp schema: 2.0.0 title: Set-DeliveryOptimizationStatus @@ -11,6 +11,8 @@ title: Set-DeliveryOptimizationStatus ## SYNOPSIS +Sets the expiration time or pinning status of Delivery Optimization cached files. + ## SYNTAX ``` @@ -20,23 +22,53 @@ Set-DeliveryOptimizationStatus [[-FileId] ] [[-Pin] ] [[-Expire ## DESCRIPTION -{{ Fill in the Description }} +The `Set-DeliveryOptimizationStatus` cmdlet changes the expiration time or pinning status of +files in the Delivery Optimization cache. + +Use **ExpireOn** to extend the expiration of a specific file, or omit **FileId** to apply the +expiration to all files. For downloads in progress, the expiration is applied after completion. + +Use **Pin** with **FileId** to pin or unpin a specific file. Pinned files are retained until their +expiration and excluded from cache quota calculations. Unpinned files are subject to normal +cache management. + +Specify at least one of **Pin** or **ExpireOn**. Pinning or unpinning requires **FileId**. ## EXAMPLES -### Example 1 +### Example 1: Extend expiration for cached files ```powershell -PS C:\> {{ Add example code here }} +Set-DeliveryOptimizationStatus -ExpireOn (Get-Date).AddDays(7) ``` -{{ Add example description here }} +This command sets the cache expiration to seven days from now for all files. + +### Example 2: Pin a specific file and set its expiration + +```powershell +$fileId = '0123456789abcdef0123456789abcdef' +Set-DeliveryOptimizationStatus -FileId $fileId -Pin $true -ExpireOn (Get-Date).AddDays(7) +``` + +This command pins the specified file and sets its expiration to seven days from now. +Replace the example ID with a **FileId** returned by `Get-DeliveryOptimizationStatus`. + +### Example 3: Unpin a cached file + +```powershell +Set-DeliveryOptimizationStatus -FileId '0123456789abcdef0123456789abcdef' -Pin $false +``` + +This command unpins the specified file, making it subject to normal cache management. ## PARAMETERS ### -ExpireOn -{{ Fill ExpireOn Description }} +Specifies the cache expiration date and time. Set a future expiration less than one year from +the current date and time. If you omit **FileId**, the expiration applies to all files. +For files still downloading, the expiration takes effect when the download completes. ```yaml Type: System.DateTime @@ -52,7 +84,9 @@ Accept wildcard characters: False ### -FileId -{{ Fill FileId Description }} +Specifies the ID of the file to update. Use `Get-DeliveryOptimizationStatus` to find file IDs. +This parameter is required when you specify **Pin**. If you specify only **ExpireOn** and omit +this parameter, the expiration applies to all files. ```yaml Type: System.String @@ -68,7 +102,8 @@ Accept wildcard characters: False ### -Pin -{{ Fill Pin Description }} +Specifies whether to pin the file. Set this parameter to `$true` to pin or `$false` to unpin. +You must also specify **FileId**. Pinning fails if the file isn't eligible for peering. ```yaml Type: System.Nullable`1[System.Boolean] @@ -91,10 +126,25 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS +### None + +You can't pipe objects to this cmdlet. + ## OUTPUTS +### None + +This cmdlet doesn't return objects. It displays update status messages in the console. + ## NOTES +Run this cmdlet from an elevated PowerShell session. Use `Get-DeliveryOptimizationStatus` to +check the resulting **ExpireOn** and **IsPinned** properties. + ## RELATED LINKS -[https://aka.ms/do-cmdlets](https://aka.ms/do-cmdlets) +[Get-DeliveryOptimizationStatus](Get-DeliveryOptimizationStatus.md) + +[Delete-DeliveryOptimizationCache](Delete-DeliveryOptimizationCache.md) + +[Monitor Delivery Optimization](https://learn.microsoft.com/windows/deployment/do/waas-delivery-optimization-monitor)