The Get-CVDiskSpace cmdlet returns the available disk space information of the library in your CommCell environment. You must provide the library name or an associated MediaAgent name.
Before you can use this cmdlet, you must log on to your CommCell environment using the Connect-CVServer cmdlet. For more information, see Connecting to a CommCell Environment with PowerShell.
Syntax
Get-CVDiskSpace -LibraryName <String> [-MountPath <String>] [<CommonParameters>]Get-CVDiskSpace -MediaAgentName <String> [-MountPath <String>] [<CommonParameters>]Get-CVDiskSpace -LibraryObject <Object> [-MountPath <String>] [<CommonParameters>]Required Parameters
Parameter | Description | Data type | Accepts pipeline input? | Accepts wildcard characters? | Type of parameter |
|---|---|---|---|---|---|
| The name of the MediaAgent. | String | Yes, by:
| No | Named |
| The name of the library on the MediaAgent. | String | Yes, by:
| No | Named |
| The name of the mount path on the library. | Object | No | No | Named |
| The name of the object associated with the library. | Object | Yes, by:
| No | Named |
Optional Parameters
Microsoft PowerShell Parameters
You can use the following Microsoft PowerShell parameters:
Debug
ErrorAction
ErrorVariable
OutBuffer
OutVariable
PipelineVariable
Verbose
WarningAction
WarningVariable
Force
Confirm
WhatIf
Note: Only a few cmdlets support Force, Confirm, and WhatIf parameters.
For more information, see "About Common Parameters" in the Microsoft PowerShell documentation.
Input
This cmdlet does not support input.
Output
A PSCustomObject that contains the storage library disk usage details.
Examples
Get Disk Space Information for a MediaAgent
The following example returns disk space information for a MediaAgent.
Get-CVDiskSpace -MediaAgentName myMediaAgentGet Disk Space Information for a Library
The following example returns disk space information for a library.
Get-CVDiskSpace -LibraryName mylibrary