exports/Set-CVSoftware.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 Upgrade software for client and client group. .Description Upgrade software for client and client group. .Example PS C:\> {{ Add code here }} {{ Add output here }} .Example PS C:\> {{ Add code here }} {{ Add output here }} .Inputs Commvault.Powershell.Models.IUpgradeSoftware .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 <IUpgradeSoftware>: Request body for server and server group upgrade software [Entities <IIdNameGuidType[]>]: List of all the client and client groups on which UpgradeSoftware should be run [Guid <String>]: [Id <Int64?>]: [Name <String>]: [Type <String>]: [InstallOSUpdates <Boolean?>]: Boolean which determines whether to install operating system updates. [InstallStorageUpdates <String>]: Enum which specifies the type of storage update [NotifyWhenJobCompletes <Boolean?>]: Boolean which determines whether to notify when software is upgraded. [RebootIfRequired <Boolean?>]: Boolean which determines whether to reboot if required. [RunDbMaintenance <Boolean?>]: Boolean which determines whether or not to run a database maintenance. [WaitForDownloadJobToComplete <Boolean?>]: Boolean which determines whether to wait for Download software job to complete before software is upgraded. ENTITIES <IIdNameGuidType[]>: List of all the client and client groups on which UpgradeSoftware should be run [Guid <String>]: [Id <Int64?>]: [Name <String>]: [Type <String>]: .Link https://docs.microsoft.com/en-us/powershell/module/commvaultpowershell/set-cvsoftware #> function Set-CVSoftware { [OutputType([System.Int64])] [CmdletBinding(DefaultParameterSetName='UpgradeExpanded', PositionalBinding=$false, SupportsShouldProcess, ConfirmImpact='Medium')] param( [Parameter(ParameterSetName='Upgrade', Mandatory, ValueFromPipeline)] [Commvault.Powershell.Category('Body')] [Commvault.Powershell.Models.IUpgradeSoftware] # Request body for server and server group upgrade software # To construct, see NOTES section for BODY properties and create a hash table. ${Body}, [Parameter(ParameterSetName='UpgradeExpanded')] [Commvault.Powershell.Category('Body')] [Commvault.Powershell.Models.IIdNameGuidType[]] # List of all the client and client groups on which UpgradeSoftware should be run # To construct, see NOTES section for ENTITIES properties and create a hash table. ${Entities}, [Parameter(ParameterSetName='UpgradeExpanded')] [Commvault.Powershell.Category('Body')] [System.Management.Automation.SwitchParameter] # Boolean which determines whether to install operating system updates. ${InstallOSUpdates}, [Parameter(ParameterSetName='UpgradeExpanded')] [Commvault.Powershell.Category('Body')] [System.String] # Enum which specifies the type of storage update ${InstallStorageUpdates}, [Parameter(ParameterSetName='UpgradeExpanded')] [Commvault.Powershell.Category('Body')] [System.Management.Automation.SwitchParameter] # Boolean which determines whether to notify when software is upgraded. ${NotifyWhenJobCompletes}, [Parameter(ParameterSetName='UpgradeExpanded')] [Commvault.Powershell.Category('Body')] [System.Management.Automation.SwitchParameter] # Boolean which determines whether to reboot if required. ${RebootIfRequired}, [Parameter(ParameterSetName='UpgradeExpanded')] [Commvault.Powershell.Category('Body')] [System.Management.Automation.SwitchParameter] # Boolean which determines whether or not to run a database maintenance. ${RunDbMaintenance}, [Parameter(ParameterSetName='UpgradeExpanded')] [Commvault.Powershell.Category('Body')] [System.Management.Automation.SwitchParameter] # Boolean which determines whether to wait for Download software job to complete before software is upgraded. ${WaitForDownloadJobToComplete}, [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 = @{ Upgrade = 'CommvaultPowershell.private\Set-CVSoftware_Upgrade'; UpgradeExpanded = 'CommvaultPowershell.private\Set-CVSoftware_UpgradeExpanded'; } $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 } } } |