Skip to content

Export-VmsHardware

SYNOPSIS

Exports detailed information about hardware devices on Milestone XProtect recording servers.

SYNTAX

Export-VmsHardware [[-RecordingServer] <RecordingServer[]>] [[-EnableFilter] <String>] [[-Path] <String>]
 [-Append] [-PassThru] [<CommonParameters>]

DESCRIPTION

Exports detailed information about hardware devices on Milestone XProtect recording servers. The information can be sent to a CSV file or returned to the pipeline, or both.

If no Path is provided, the information will be output to the pipeline automatically without the PassThru switch.

REQUIREMENTS

  • Requires VMS connection and will attempt to connect automatically

EXAMPLES

EXAMPLE 1

Export-VmsHardware -Path C:\temp\hardware.csv -PassThru | Out-GridView

Writes the exported hardware information to disk and displays the data in a grid view as well.

EXAMPLE 2

Export-VmsHardware -RecordingServer (Get-VmsRecordingServer | Out-GridView -OutputMode Multiple) -Path C:\temp\hardware.csv

Displays a grid view dialog where you can select one or more Recording Servers to perform a hardware export on.

PARAMETERS

-Append

Specifies that the exported hardware information should be appended to an existing CSV file.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

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

-EnableFilter

Specifies whether to return information about enabled object, disabled objects, or all.

Type: String
Parameter Sets: (All)
Aliases:
Accepted values: All, Enabled, Disabled

Required: False
Position: 1
Default value: Enabled
Accept pipeline input: False
Accept wildcard characters: False

-PassThru

Specifies that each row of data should be returned to the pipeline.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

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

-Path

Specifies a path where exported hardware information should be saved.

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-RecordingServer

Specifies one or more RecordingServer objects as returned from Get-VmsRecordingServer.

Type: RecordingServer[]
Parameter Sets: (All)
Aliases:

Required: False
Position: 0
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

System.Management.Automation.PSObject

NOTES