exports/Invoke-CVDownloadSoftware.ps1
|
# ---------------------------------------------------------------------------------- # # Copyright Microsoft Corporation # Licensed under the Apache License, Version 2.0 (the "License"); # you may not use this file except in compliance with the License. # You may obtain a copy of the License at # http://www.apache.org/licenses/LICENSE-2.0 # Unless required by applicable law or agreed to in writing, software # distributed under the License is distributed on an "AS IS" BASIS, # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. # See the License for the specific language governing permissions and # limitations under the License. # ---------------------------------------------------------------------------------- <# .Synopsis Download or Copy Software .Description Download or Copy Software .Example PS C:\> {{ Add code here }} {{ Add output here }} .Example PS C:\> {{ Add code here }} {{ Add output here }} .Inputs Commvault.Powershell.Models.IDownloadOrCopySoftware .Outputs System.Int64 .Notes COMPLEX PARAMETER PROPERTIES To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. BODY <IDownloadOrCopySoftware>: Request body for download or copy software [CopyConfigurationDownloadPath <String>]: Path from where the software has to be downloaded. [CopyConfigurationPassword <String>]: Corresponding password of the user [CopyConfigurationUsername <String>]: If impersonation a user the, give the username of the user. [DownloadConfigurationFeatureRelease <String>]: Which specific feature release to download. [DownloadConfigurationLatestFixesForCurrentRelease <Boolean?>]: Boolean which determines whether to download latest fixews for current release. [DownloadConfigurationUnixDownloadOptions <String[]>]: gives list of all the target unix and MAC operating systems to download software for. [DownloadConfigurationUpgradeToLatestRelease <Boolean?>]: Boolean which determines whether to upgrade to latest release. [DownloadConfigurationWindowsDownloadOptions <String[]>]: gives list of all the target windows operating systems to download software for. [NotifyWhenJobCompletes <Boolean?>]: Boolean which determines whether to notify when software is downloaded or copied. .Link https://docs.microsoft.com/en-us/powershell/module/commvaultpowershell/invoke-cvdownloadsoftware #> function Invoke-CVDownloadSoftware { [OutputType([System.Int64])] [CmdletBinding(DefaultParameterSetName='DownloadExpanded', PositionalBinding=$false, SupportsShouldProcess, ConfirmImpact='Medium')] param( [Parameter(ParameterSetName='Download', Mandatory, ValueFromPipeline)] [Commvault.Powershell.Category('Body')] [Commvault.Powershell.Models.IDownloadOrCopySoftware] # Request body for download or copy software # To construct, see NOTES section for BODY properties and create a hash table. ${Body}, [Parameter(ParameterSetName='DownloadExpanded')] [Commvault.Powershell.Category('Body')] [System.String] # Path from where the software has to be downloaded. ${CopyConfigurationDownloadPath}, [Parameter(ParameterSetName='DownloadExpanded')] [Commvault.Powershell.Category('Body')] [System.String] # Corresponding password of the user ${CopyConfigurationPassword}, [Parameter(ParameterSetName='DownloadExpanded')] [Commvault.Powershell.Category('Body')] [System.String] # If impersonation a user the, give the username of the user. ${CopyConfigurationUsername}, [Parameter(ParameterSetName='DownloadExpanded')] [Commvault.Powershell.Category('Body')] [System.String] # Which specific feature release to download. ${DownloadConfigurationFeatureRelease}, [Parameter(ParameterSetName='DownloadExpanded')] [Commvault.Powershell.Category('Body')] [System.Management.Automation.SwitchParameter] # Boolean which determines whether to download latest fixews for current release. ${DownloadConfigurationLatestFixesForCurrentRelease}, [Parameter(ParameterSetName='DownloadExpanded')] [Commvault.Powershell.Category('Body')] [System.String[]] # gives list of all the target unix and MAC operating systems to download software for. ${DownloadConfigurationUnixDownloadOptions}, [Parameter(ParameterSetName='DownloadExpanded')] [Commvault.Powershell.Category('Body')] [System.Management.Automation.SwitchParameter] # Boolean which determines whether to upgrade to latest release. ${DownloadConfigurationUpgradeToLatestRelease}, [Parameter(ParameterSetName='DownloadExpanded')] [Commvault.Powershell.Category('Body')] [System.String[]] # gives list of all the target windows operating systems to download software for. ${DownloadConfigurationWindowsDownloadOptions}, [Parameter(ParameterSetName='DownloadExpanded')] [Commvault.Powershell.Category('Body')] [System.Management.Automation.SwitchParameter] # Boolean which determines whether to notify when software is downloaded or copied. ${NotifyWhenJobCompletes}, [Parameter(DontShow)] [Commvault.Powershell.Category('Runtime')] [System.Management.Automation.SwitchParameter] # Wait for .NET debugger to attach ${Break}, [Parameter(DontShow)] [ValidateNotNull()] [Commvault.Powershell.Category('Runtime')] [Commvault.Powershell.Runtime.SendAsyncStep[]] # SendAsync Pipeline Steps to be appended to the front of the pipeline ${HttpPipelineAppend}, [Parameter(DontShow)] [ValidateNotNull()] [Commvault.Powershell.Category('Runtime')] [Commvault.Powershell.Runtime.SendAsyncStep[]] # SendAsync Pipeline Steps to be prepended to the front of the pipeline ${HttpPipelinePrepend}, [Parameter(DontShow)] [Commvault.Powershell.Category('Runtime')] [System.Uri] # The URI for the proxy server to use ${Proxy}, [Parameter(DontShow)] [ValidateNotNull()] [Commvault.Powershell.Category('Runtime')] [System.Management.Automation.PSCredential] # Credentials for a proxy server to use for the remote call ${ProxyCredential}, [Parameter(DontShow)] [Commvault.Powershell.Category('Runtime')] [System.Management.Automation.SwitchParameter] # Use the default credentials for the proxy ${ProxyUseDefaultCredentials} ) begin { try { $outBuffer = $null if ($PSBoundParameters.TryGetValue('OutBuffer', [ref]$outBuffer)) { $PSBoundParameters['OutBuffer'] = 1 } $parameterSet = $PSCmdlet.ParameterSetName $mapping = @{ Download = 'CommvaultPowershell.private\Invoke-CVDownloadSoftware_Download'; DownloadExpanded = 'CommvaultPowershell.private\Invoke-CVDownloadSoftware_DownloadExpanded'; } $wrappedCmd = $ExecutionContext.InvokeCommand.GetCommand(($mapping[$parameterSet]), [System.Management.Automation.CommandTypes]::Cmdlet) $scriptCmd = {& $wrappedCmd @PSBoundParameters} $steppablePipeline = $scriptCmd.GetSteppablePipeline($MyInvocation.CommandOrigin) $steppablePipeline.Begin($PSCmdlet) } catch { throw } } process { try { $steppablePipeline.Process($_) } catch { throw } } end { try { $steppablePipeline.End() } catch { throw } } } |