Skip to content

Get-AppVentiXUserSettings

SYNOPSIS

Retrieves the AppVentiX User Settings from the configuration share.

SYNTAX

__AllParameterSets

Get-AppVentiXUserSettings [[-Setting] <string>] [[-ConfigShare] <string>] [<CommonParameters>]

ALIASES

This cmdlet has the following aliases,

DESCRIPTION

The Get-AppVentiXUserSettings function reads the User Setting XML files from the AppVentiX configuration share and returns them as objects. You can retrieve all User Settings or filter on a specific setting type.

EXAMPLES

EXAMPLE 1

Get-AppVentiXUserSettings

Retrieves all User Settings from the AppVentiX configuration share.

EXAMPLE 2

Get-AppVentiXUserSettings -Setting DriveMapping

Retrieves only the Drive Mapping User Settings.

PARAMETERS

-ConfigShare

Specifies the path to the AppVentiX configuration share. You can omit this parameter if the configuration store was already set with Set-AppVentiXConfigShare, or when it can be detected automatically (for example on a machine where AppVentiX Central View is installed and configured).

Type: System.String
DefaultValue: $Script:AppVentiX.ConfigShare
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: (All)
  Position: 1
  IsRequired: false
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

-Setting

Specifies the type of User Setting to retrieve. Valid values are 'All', 'DriveMapping', 'EnvironmentVariables' and 'PrinterMapping'. Defaults to 'All'.

Type: System.String
DefaultValue: All
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: (All)
  Position: 0
  IsRequired: false
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

CommonParameters

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

INPUTS

OUTPUTS