exports/Start-CVJobOperationOnPlanBackupDestination.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 Run different job operations for a plan backup destination .Description Run different job operations for a plan backup destination .Example PS C:\> {{ Add code here }} {{ Add output here }} .Example PS C:\> {{ Add code here }} {{ Add output here }} .Inputs Commvault.Powershell.Models.IJobOperationOnCopyReq .Outputs Commvault.Powershell.Models.IGenericResp .Outputs Commvault.Powershell.Models.IJobOperationOnCopyResp .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 <IJobOperationOnCopyReq>: JobOperationOnCopyReq CommcellId <Int64>: ID for chosen commcell CopyId <Int64>: ID for chosen copy JobIds <Int64>: Comma separated Job IDs to run job operation on OpType <String>: StoragePolicyId <Int64>: ID for chosen storage policy [LoadArchiverJobs <Boolean?>]: Defines whether archiver jobs need to be computed. [LoadDependentJobs <Boolean?>]: Defines whether dependent jobs need to be computed. [RetainUntilTime <Int64?>]: Job will be retained till specified time. The time is provided in unix time format. .Link https://docs.microsoft.com/en-us/powershell/module/commvaultpowershell/start-cvjoboperationonplanbackupdestination #> function Start-CVJobOperationOnPlanBackupDestination { [OutputType([Commvault.Powershell.Models.IJobOperationOnCopyResp], [Commvault.Powershell.Models.IGenericResp])] [CmdletBinding(DefaultParameterSetName='RunExpanded', PositionalBinding=$false, SupportsShouldProcess, ConfirmImpact='Medium')] param( [Parameter(ParameterSetName='Run', Mandatory, ValueFromPipeline)] [Commvault.Powershell.Category('Body')] [Commvault.Powershell.Models.IJobOperationOnCopyReq] # JobOperationOnCopyReq # To construct, see NOTES section for BODY properties and create a hash table. ${Body}, [Parameter(ParameterSetName='RunExpanded', Mandatory)] [Commvault.Powershell.Category('Body')] [System.Int64] # ID for chosen commcell ${CommcellId}, [Parameter(ParameterSetName='RunExpanded', Mandatory)] [Commvault.Powershell.Category('Body')] [System.Int64] # ID for chosen copy ${CopyId}, [Parameter(ParameterSetName='RunExpanded', Mandatory)] [Commvault.Powershell.Category('Body')] [System.Int64] # Comma separated Job IDs to run job operation on ${JobIds}, [Parameter(ParameterSetName='RunExpanded', Mandatory)] [Commvault.Powershell.Category('Body')] [System.String] # . ${OpType}, [Parameter(ParameterSetName='RunExpanded', Mandatory)] [Commvault.Powershell.Category('Body')] [System.Int64] # ID for chosen storage policy ${StoragePolicyId}, [Parameter(ParameterSetName='RunExpanded')] [Commvault.Powershell.Category('Body')] [System.Management.Automation.SwitchParameter] # Defines whether archiver jobs need to be computed. ${LoadArchiverJobs}, [Parameter(ParameterSetName='RunExpanded')] [Commvault.Powershell.Category('Body')] [System.Management.Automation.SwitchParameter] # Defines whether dependent jobs need to be computed. ${LoadDependentJobs}, [Parameter(ParameterSetName='RunExpanded')] [Commvault.Powershell.Category('Body')] [System.Int64] # Job will be retained till specified time. # The time is provided in unix time format. ${RetainUntilTime}, [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 = @{ Run = 'CommvaultPowershell.private\Start-CVJobOperationOnPlanBackupDestination_Run'; RunExpanded = 'CommvaultPowershell.private\Start-CVJobOperationOnPlanBackupDestination_RunExpanded'; } $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 } } } |