Skip to content

Get-VmsStorage

SYNOPSIS

Gets the Storage objects representing the live recording storages on Milestone XProtect recording servers

SYNTAX

FromName

Get-VmsStorage -RecordingServer <RecordingServer> [-Name <String>] [<CommonParameters>]

FromPath

Get-VmsStorage [-ItemPath <String>] [<CommonParameters>]

DESCRIPTION

Gets the Storage objects representing the live recording storages on Milestone XProtect recording servers

EXAMPLES

EXAMPLE 1

Get-RecordingServer -Name 'Recorder 1' | Get-VmsStorage

Gets all storage configurations on the recording server named 'Recorder 1

EXAMPLE 2

Get-RecordingServer | Get-VmsStorage -Name 'Local*'

Gets all storage configurations on all recording servers where the name begins with 'Local'

EXAMPLE 3

$camera | Get-VmsStorage

Gets the storage configuration associated with the Camera object in the variable $camera

PARAMETERS

-ItemPath

Specifies the Milestone Configuration API path for the storage configuration. For example, Storage[eef84b4a-1e7a-4f99-ac5f-671ae76d520b] Note: You may pipe a camera object to this cmdlet and the RecordingStorage alias will be used to identify the correct storage configuration

Type: String
Parameter Sets: FromPath
Aliases: RecordingStorage, Path

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-Name

Specifies the name of the storage configuration to return. Supports wildcards.

Type: String
Parameter Sets: FromName
Aliases:

Required: False
Position: Named
Default value: *
Accept pipeline input: False
Accept wildcard characters: True

-RecordingServer

Specifies the Recording Server object from which to return storage configurations

Type: RecordingServer
Parameter Sets: FromName
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS

OUTPUTS

VideoOS.Platform.ConfigurationItems.Storage

NOTES

Online Help