Edit

Share via

Unregister-UevTemplate

Module:
UEV Module

Unregisters a settings location template from Microsoft User Experience Virtualization (UE-V).

Syntax

ParameterSetTemplateId 

Unregister-UevTemplate
    [-ID] <String>
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

ParameterSetAllTemplates 

Unregister-UevTemplate
    [-All]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Description

The Unregister-UevTemplate cmdlet unregisters a settings location template from Microsoft User Experience Virtualization (UE-V). A template defines settings to synchronize between computers. After you unregister a template, UE-V no longer synchronizes those settings. If you try to unregister a template that is not registered, the cmdlet returns an error.

You must have administrative credentials to run this cmdlet.

Examples

Example 1: Unregister a template

PS C:\> Unregister-UevTemplate -TemplateId "MicrosoftCalculator6"

This command unregisters a settings location template that has the ID MicrosoftCalculator6.

Example 2: Unregister templates for applications that match a specified string

PS C:\> Get-UevTemplate -Application "calc" | Unregister-UevTemplate

This command uses the Get-UevTemplate cmdlet to get all the registered settings location templates whose application name contains the specified string, and then passes them to the current cmdlet by using the pipeline operator. The cmdlet unregisters all the templates for applications that contain the string calc.

Example 3: Unregister all templates

PS C:\> Unregister-UevTemplate -All

This command unregisters all the settings location templates that are currently registered with UE-V.

Parameters

-All

Indicates that the cmdlet unregisters all settings location templates.

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

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

-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

-ID

Specifies the ID of a settings location template. The cmdlet unregisters the template that you specify. If you specify an ID for a template that is not registered, the cmdlet returns an error.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False
Aliases:TemplateID

Parameter sets

ParameterSetTemplateId
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

The settings location template ID.