public/Set-LSUClientConfiguration.ps1
|
function Set-LSUClientConfiguration { <# .DESCRIPTION Sets global configuration options for LSUClient that may affect multiple cmdlets. .PARAMETER InputObject Import and set all configuration options from an LSUClientConfiguration object. .PARAMETER Proxy Set the default Proxy URL for all cmdlets to use. .PARAMETER ProxyCredential Specifies the default Proxy user account for all cmdlets to use. .PARAMETER ProxyUseDefaultCredentials Set all cmdlets to use the credentials of the current user to access the proxy server by default. .PARAMETER MaxExternalDetectionRuntime Sets a time limit for how long external detection processes can run before they're forcefully stopped. .PARAMETER MaxExtractRuntime Sets a time limit for how long package extractions can run before they're forcefully stopped. .PARAMETER MaxInstallerRuntime Sets a time limit for how long package installers can run before they're forcefully stopped. As a safety measure this limit is not applied for installers of firmware or BIOS/UEFI updates. .EXAMPLE # Disable the default MaxExternalDetectionRuntime PS> Set-LSUClientConfiguration -MaxExternalDetectionRuntime ([TimeSpan]::Zero) .EXAMPLE # Set a maximum allowed installer runtime of 20 minutes PS> Set-LSUClientConfiguration -MaxInstallerRuntime (New-TimeSpan -Minutes 20) .EXAMPLE # Disable a previously configured Proxy PS> Set-LSUClientConfiguration -Proxy $null .EXAMPLE # Apply a previously saved or edited configuration PS> $config = Get-LSUClientConfiguration PS> # ... PS> $config | Set-LSUClientConfiguration #> [CmdletBinding(DefaultParameterSetName = 'Whole')] Param ( [Parameter(Mandatory = $true, ParameterSetName = 'Whole', ValueFromPipeline = $true, Position = 0)] [LSUClientConfiguration]$InputObject, [Parameter(ParameterSetName = 'Individual')] [Uri]$Proxy, [Parameter(ParameterSetName = 'Individual')] [PSCredential]$ProxyCredential, [Parameter(ParameterSetName = 'Individual')] [bool]$ProxyUseDefaultCredential, [Parameter(ParameterSetName = 'Individual')] [TimeSpan]$MaxExternalDetectionRuntime, [Parameter(ParameterSetName = 'Individual')] [TimeSpan]$MaxExtractRuntime, [Parameter(ParameterSetName = 'Individual')] [TimeSpan]$MaxInstallerRuntime ) begin { if ($PSBoundParameters['Debug'] -and $DebugPreference -eq 'Inquire') { Write-Verbose "Adjusting the DebugPreference to 'Continue'." $DebugPreference = 'Continue' } } process { if ($InputObject) { # Assign a new / decoupled instance of the configuration passed in # so that changing values on the object doesn't immediately apply $script:LSUClientConfiguration = [LSUClientConfiguration]::new($InputObject) } else { # For every parameter that was set/passed, update the configuration # This allows to 'unset' options (for example Proxy) by intentionally # passing an empty string or null. foreach ($kv in $PSBoundParameters.GetEnumerator()) { # Ignore / skip parameters that aren't configuration options, # such as the common -Verbose, -Debug, -ErrorAction etc. etc. if ([LSUClientConfiguration].GetProperty($kv.Key)) { Write-Debug "Setting option '$($kv.Key)' to: $($kv.Value)" $script:LSUClientConfiguration."$($kv.Key)" = $kv.Value } } } } } |