exports/Get-CVDiskSpace.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 available disk space of the library. .Description Method to retrieve the available disk space of the library. Requires either the LibraryName or an associated MediaAgentName. .Example PS C:\> {{ Add code here }} {{ Add output here }} .Example PS C:\> {{ Add code here }} {{ Add output here }} .Inputs System.Object .Inputs System.String .Outputs System.Management.Automation.PSObject .Link https://docs.microsoft.com/en-us/powershell/module/commvaultpowershell/get-cvdiskspace #> function Get-CVDiskSpace { [OutputType([System.Management.Automation.PSObject])] [CmdletBinding(DefaultParameterSetName='ByLibraryName', PositionalBinding=$false)] param( [Parameter(ParameterSetName='ByLibraryName', Mandatory, ValueFromPipeline, ValueFromPipelineByPropertyName)] [Commvault.Powershell.Category('Body')] [System.String] # Retrieve available disk space details for the library specified by LibraryName. ${LibraryName}, [Parameter()] [Commvault.Powershell.Category('Body')] [System.String] # Filter output for a specific MountPath. ${MountPath}, [Parameter(ParameterSetName='ByMediaAgentName', Mandatory, ValueFromPipeline, ValueFromPipelineByPropertyName)] [Alias('MAName')] [Commvault.Powershell.Category('Body')] [System.String] # Retrieve available disk space details for libraries associated with MediaAgentName. ${MediaAgentName}, [Parameter(ParameterSetName='ByLibraryObject', Mandatory, ValueFromPipeline, ValueFromPipelineByPropertyName)] [Commvault.Powershell.Category('Body')] [System.Object] ${LibraryObject} ) begin { try { $outBuffer = $null if ($PSBoundParameters.TryGetValue('OutBuffer', [ref]$outBuffer)) { $PSBoundParameters['OutBuffer'] = 1 } $parameterSet = $PSCmdlet.ParameterSetName $mapping = @{ ByLibraryName = 'CommvaultPowershell.custom\Get-CVDiskSpace'; ByMediaAgentName = 'CommvaultPowershell.custom\Get-CVDiskSpace'; ByLibraryObject = 'CommvaultPowershell.custom\Get-CVDiskSpace'; } $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 } } } |