exports/Backup-CVVirtualMachine.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 Method to initiate backup of specified virtual machine. .Description Method to initiate backup of specified virtual machine. .Example PS C:\> {{ Add code here }} {{ Add output here }} .Example PS C:\> {{ Add code here }} {{ Add output here }} .Inputs System.Object .Outputs System.Management.Automation.PSObject .Link https://docs.microsoft.com/en-us/powershell/module/commvaultpowershell/backup-cvvirtualmachine #> function Backup-CVVirtualMachine { [Alias('Backup-CVVM')] [OutputType([System.Management.Automation.PSObject])] [CmdletBinding(DefaultParameterSetName='ByName', PositionalBinding=$false, SupportsShouldProcess, ConfirmImpact='Medium')] param( [Parameter(ParameterSetName='ByName', Mandatory)] [Commvault.Powershell.Category('Body')] [System.String] # Virtual machine Name. ${Name}, [Parameter(ParameterSetName='ByName', Mandatory)] [Commvault.Powershell.Category('Body')] [System.String] # Virtual machine associated ClientName. ${ClientName}, [Parameter()] [Commvault.Powershell.Category('Body')] [CVBackupType] # Backup Type for the backup of Virtual Machine , default is INCREMENTAL . # Supported values are FULL, INCREMENTAL, DIFFERENTIAL, SYNTHETIC_FULL ${BackupType}, [Parameter()] [Commvault.Powershell.Category('Body')] [System.Management.Automation.SwitchParameter] # Use this switch to filter legacy, unprotected virtual machines when specifed by Name. ${Protected}, [Parameter()] [Commvault.Powershell.Category('Body')] [System.Management.Automation.SwitchParameter] # Switch to Force override of default 'WhatIf' confirmation behavior. ${Force}, [Parameter(ParameterSetName='ById', Mandatory)] [Alias('VMName')] [Commvault.Powershell.Category('Body')] [System.String] # Virtual machine Id: this is the virtual machine GUID. ${Id}, [Parameter(ParameterSetName='ByObject', Mandatory, ValueFromPipeline, ValueFromPipelineByPropertyName)] [Commvault.Powershell.Category('Body')] [System.Object] # Virtual machine associated client specified by piped ClientObject. ${ClientObject} ) begin { try { $outBuffer = $null if ($PSBoundParameters.TryGetValue('OutBuffer', [ref]$outBuffer)) { $PSBoundParameters['OutBuffer'] = 1 } $parameterSet = $PSCmdlet.ParameterSetName $mapping = @{ ByName = 'CommvaultPowershell.custom\Backup-CVVirtualMachine'; ById = 'CommvaultPowershell.custom\Backup-CVVirtualMachine'; ByObject = 'CommvaultPowershell.custom\Backup-CVVirtualMachine'; } $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 } } } |