Loading...

Get-CVDiskSpace

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 in 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

You must provide a value for at least one of the following parameters.

-MediaAgentName

The name of the MediaAgent.

  • Type: String
  • Required: True
  • Aliases: None
  • Default value: None
  • Accepts pipeline input: True (ByValue, ByPropertyName)
  • Accepts wildcard characters: False
  • Position: Named

-LibraryName

The name of the library.

  • Type: String
  • Required: True
  • Aliases: None
  • Default value: None
  • Accepts pipeline input: True (ByValue, ByPropertyName)
  • Accepts wildcard characters: False
  • Position: Named

-MountPath

The name of the mount path on the library.

  • Type: String
  • Required: False
  • Aliases: None
  • Default value: None
  • Accepts pipeline input: False
  • Accepts wildcard characters: False
  • Position: Named

-LibraryObject

The name of the object associated with the library.

  • Type: Object
  • Required: True
  • Aliases: None
  • Default value: None
  • Accepts pipeline input: False (ByValue, ByPropertyName)
  • Accepts wildcard characters: False
  • Position: Named

Optional Parameters

<CommonParameters>

A collection of parameters that you can use with any cmdlet.

The following Microsoft PowerShell common parameters are supported:

  • Verbose
  • Debug
  • ErrorAction
  • ErrorVariable
  • WarningAction
  • WarningVariable
  • OutBuffer
  • PipelineVariable
  • OutVariable

The following Microsoft PowerShell mitigation parameters are supported:

  • WhatIf
  • Confirm

For more information, see About CommonParameters in the Microsoft PowerShell documentation.

Inputs

None

This cmdlet does not support any inputs.

Outputs

The output (type PSCustomObject) contains the storage library disk usage details.

Examples

Example 1: Get Disk Space Information for a MediaAgent

The following example returns disk space information for a MediaAgent in your CommCell environment.

Get-CVDiskSpace -MediaAgentName myMediaAgent

Example 2: Get Disk Space Information for a Library

The following example returns disk space information for a library in your CommCell environment.

Get-CVDiskSpace -LibraryName mylibrary

Last modified: 11/21/2019 8:25:29 PM