exports/Get-CVId.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 retrieve the Id for a given Entity from the CommServe. .Description Method to retrieve the Id for a given Entity from the CommServe. .Example PS C:\> {{ Add code here }} {{ Add output here }} .Example PS C:\> {{ Add code here }} {{ Add output here }} .Inputs System.String .Outputs System.Management.Automation.PSObject .Link https://docs.microsoft.com/en-us/powershell/module/commvaultpowershell/get-cvid .Link All Agent Names: https://documentation.commvault.com/commvault/v11/article?p=45467.htm#o99081 #> function Get-CVId { [OutputType([System.Management.Automation.PSObject])] [CmdletBinding(PositionalBinding=$false)] param( [Parameter(Position=0, Mandatory, ValueFromPipeline, ValueFromPipelineByPropertyName)] [Commvault.Powershell.Category('Body')] [System.String] # Get Client Id for ClientName. ${ClientName}, [Parameter(Position=1, ValueFromPipeline, ValueFromPipelineByPropertyName)] [Commvault.Powershell.Category('Body')] [System.String] # Get Application Id for AgentName. # Example 'File System', 'Active Directory Agent' ${AgentName}, [Parameter(Position=2, ValueFromPipeline, ValueFromPipelineByPropertyName)] [Commvault.Powershell.Category('Body')] [System.String] # Get BackupSet Id for BackupSetName. ${BackupSetName}, [Parameter(Position=3, ValueFromPipeline, ValueFromPipelineByPropertyName)] [Commvault.Powershell.Category('Body')] [System.String] # Get Instance Id for InstanceName. ${InstanceName}, [Parameter(Position=4, ValueFromPipeline, ValueFromPipelineByPropertyName)] [Commvault.Powershell.Category('Body')] [System.String] # Get Subclient Id for SubclientName. ${SubclientName} ) begin { try { $outBuffer = $null if ($PSBoundParameters.TryGetValue('OutBuffer', [ref]$outBuffer)) { $PSBoundParameters['OutBuffer'] = 1 } $parameterSet = $PSCmdlet.ParameterSetName $mapping = @{ __AllParameterSets = 'CommvaultPowershell.custom\Get-CVId'; } $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 } } } |