Skip to content

Get-RpVmsHardwareCustom

SYNOPSIS

Retrieves and displays the hardware settings of VMS items with optional connection validation and credentials inclusion.

SYNTAX

NoConnectionCheck (Default)

Get-RpVmsHardwareCustom [-IncludeCredentials] [-ProgressAction <ActionPreference>] [<CommonParameters>]

ConnectionCheck

Get-RpVmsHardwareCustom [-CheckConnection] [-IncludeCredentials] [-ProgressAction <ActionPreference>]
 [<CommonParameters>]

DESCRIPTION

This function retrieves the hardware settings of VMS items and displays the results in an HTML view. It also provides optional parameters to validate the connection before processing and to include credentials in the output.

EXAMPLES

EXAMPLE 1

Get-RpVmsHardwareCustom -CheckConnection

This example validates the VMS connection before retrieving and displaying the hardware settings of the items.

EXAMPLE 2

Get-RpVmsHardwareCustom -IncludeCredentials

This example retrieves and displays the hardware settings of the items, including the username and password for each item.

PARAMETERS

-CheckConnection

Validates the VMS connection before processing the items. If the connection is not valid, the function will display an error message and exit early.

Type: SwitchParameter
Parameter Sets: ConnectionCheck
Aliases:

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

-IncludeCredentials

Includes the username and password in the output for each hardware item.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

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

-ProgressAction

{{ Fill ProgressAction Description }}

Type: ActionPreference
Parameter Sets: (All)
Aliases: proga

Required: False
Position: Named
Default value: None
Accept pipeline input: False
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

NOTES

https://www.remotepro.dev/en-US/Get-RpVmsHardwareCustom