Get-VmsHardware
SYNOPSIS
Gets existing Hardware devices added to recording servers on the currently connected management server.
SYNTAX
All (Default)
Get-VmsHardware [-All] [-CaseSensitive] [<CommonParameters>]
Filtered
Get-VmsHardware [-RecordingServer <RecordingServer>] [-Id <Guid>] [-RecorderId <Guid>] [-Name <String>]
[-CaseSensitive] [<CommonParameters>]
DESCRIPTION
The GetVmsHardware cmdlet returns all hardware on all recording servers on
the currently connected management server, or all hardware on a specific
recording server.
EXAMPLES
Example 1
Get-VmsHardware
Returns all hardware on all recording servers.
Example 2
Get-VmsHardware | Where-Object Enabled
Returns all enabled hardware on all recording servers.
Example 3
$recorder = Get-VmsRecordingServer | Select-Object -First 1
$recorder | Get-VmsHardware
Returns all hardware on one recording server.
PARAMETERS
-All
Obsolete. Specifies that all hardware from all recorders should be returned. This is the default behavior when no parameters are specified.
Type: SwitchParameter
Parameter Sets: All
Aliases:
Required: False
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-CaseSensitive
Specifies that the Name parameter should be used to perform a case-sensitive filter. The default behavior is to filter based on case-insensitive matching.
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: 50
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Id
Specifies the hardware ID of an existing hardware device.
Type: Guid
Parameter Sets: Filtered
Aliases: HardwareId
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Name
Specifies a name with support for wildcards.
Type: String
Parameter Sets: Filtered
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: True
-RecorderId
Specifies the ID of a recording server from which to retrieve hardware.
Type: Guid
Parameter Sets: Filtered
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-RecordingServer
Specifies a recording server object from which to retrieve hardware. Use
Get-VmsRecordingServer to retrieve a recording server object.
Type: RecordingServer
Parameter Sets: Filtered
Aliases:
Required: False
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.