Edit

Share via


Register-UevTemplate

Registers a settings location template with UE-V.

Syntax

Path (Default)

Register-UevTemplate
    [-Path] <String[]>
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

LiteralPath

Register-UevTemplate
    -LiteralPath <String[]>
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Description

The Register-UevTemplate cmdlet registers a settings location template with Microsoft User Experience Virtualization (UE-V). A template defines settings to synchronize between computers. After you register a template, UE-V synchronizes the settings. If you try to register a template that is already registered, the cmdlet returns an error.

You must have administrative credentials to run this cmdlet.

Examples

Example 1: Register a template

PS C:\> Register-UevTemplate -Path "MicrosoftCalculator.xml"

This command registers a template in the current directory.

Example 2: Register multiple templates

PS C:\> Register-UevTemplate -Path "Microsoft*.xml"

This command uses a wildcard to specify multiple templates in the current directory.

Example 3: Register all templates in a directory

PS C:\> Register-UevTemplate -Path "*.xml"

This command uses a wildcard to register all settings location templates that are in the current directory but that are not currently registered.

Example 4: Register a template by using a literal path

PS C:\> Register-UevTemplate -LiteralPath "C:\Program Files\Microsoft User Experience Virtualization\Templates\MicrosoftCalculator.xml"

This command registers a settings location template by using the literal path of the template file.

Parameters

-Confirm

Prompts you for confirmation before running the cmdlet.

Parameter properties

Type:SwitchParameter
Default value:False
Supports wildcards:False
DontShow:False
Aliases:cf

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-LiteralPath

Specifies an array of literal file paths. The cmdlet registers the settings location templates that have the literal paths that you specify.

Parameter properties

Type:

String[]

Default value:None
Supports wildcards:False
DontShow:False
Aliases:PSPath

Parameter sets

LiteralPath
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False

-Path

Specifies an array of file paths. The cmdlet registers the settings location templates that have the paths that you specify. Use wildcards to specify multiple files.

Parameter properties

Type:

String[]

Default value:None
Supports wildcards:False
DontShow:False
Aliases:Name

Parameter sets

Path
Position:0
Mandatory:True
Value from pipeline:True
Value from pipeline by property name:True
Value from remaining arguments:False

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Parameter properties

Type:SwitchParameter
Default value:False
Supports wildcards:False
DontShow:False
Aliases:wi

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

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

string

An array of paths to the settings location templates.