Skip to content

Get-RpSettings

SYNOPSIS

Retrieves RemotePro settings.

SYNTAX

Get-RpSettings [-All] [-ProgressAction <ActionPreference>] [<CommonParameters>]

DESCRIPTION

The Get-RpSettings function retrieves the settings from the RemotePro controller object. If the -All switch is specified, it returns all settings values; otherwise, it returns the settings object.

EXAMPLES

EXAMPLE 1

Get-RpSettings

Retrieves the settings object from the RemotePro controller.

EXAMPLE 2

Get-RpSettings -All

Retrieves all settings values from the RemotePro controller.

PARAMETERS

-All

If specified, returns all settings values.

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