exports/Add-CVVirtualMachineGroupContent.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 perform a virtual machine group content preview with option to create clients from result set. .Description Method to perform a virtual machine group content preview with option to create clients from result set. .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/add-cvvirtualmachinegroupcontent #> function Add-CVVirtualMachineGroupContent { [OutputType([System.Management.Automation.PSObject])] [CmdletBinding(DefaultParameterSetName='ByObject', PositionalBinding=$false, SupportsShouldProcess, ConfirmImpact='Medium')] param( [Parameter(Mandatory, ValueFromPipeline, ValueFromPipelineByPropertyName)] [Commvault.Powershell.Category('Body')] [System.Object] # Virtual machine group for content preview. # Can be piped or passed as a parameter. ${SubclientObject}, [Parameter(Mandatory)] [Commvault.Powershell.Category('Body')] [CVVMGroupContentEntityType] # Virtual server EntityType including: Host, Datastore, VMName, VMNamePattern, GuestOS, GuestDNSHostname, PoweredState, Notes, TemplateState, Tag, and TagCategory. ${EntityType}, [Parameter()] [Commvault.Powershell.Category('Body')] [CVVSAPowerState] # Paired with EntityType PoweredState: On, Off, Other. ${PoweredState}, [Parameter()] [Commvault.Powershell.Category('Body')] [System.Boolean] # Paired with EntityType TemplateState: $True or $False. ${TemplateState}, [Parameter()] [Commvault.Powershell.Category('Body')] [CVMatchingPattern] # Matching pattern to be used for search on DisplayName can be: Contains, Equals, StartsWith, or EndsWith. ${MatchingPattern}, [Parameter()] [Commvault.Powershell.Category('Body')] [System.String] # Search Term. ${DisplayName}, [Parameter()] [Commvault.Powershell.Category('Body')] [System.String] # This is the VM GUID ${VMName}, [Parameter()] [Commvault.Powershell.Category('Body')] [System.Management.Automation.SwitchParameter] # Switch to create clients for discovered virtual machines. # # Recommend running first without this switch to preview discovery results. ${CreateClientsForDiscoveredVms}, [Parameter()] [Commvault.Powershell.Category('Body')] [System.Management.Automation.SwitchParameter] # Switch to Force override of default 'WhatIf' confirmation behavior. ${Force} ) begin { try { $outBuffer = $null if ($PSBoundParameters.TryGetValue('OutBuffer', [ref]$outBuffer)) { $PSBoundParameters['OutBuffer'] = 1 } $parameterSet = $PSCmdlet.ParameterSetName $mapping = @{ ByObject = 'CommvaultPowershell.custom\Add-CVVirtualMachineGroupContent'; } $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 } } } |