Remove-RASTemplate.md

NAME

Remove-RASTemplate

SYNOPSIS

Remove a Template property.

SYNTAX

Remove-RASTemplate [Id] (uint) -ObjType {RDSTemplate | VDITemplate | AVDTemplate} [DeleteAllCreatedHosts (SwitchParameter)] [(CommonParameters)]

**Remove-RASTemplate [-InputObject] (Template) -ObjType {RDSTemplate | VDITemplate | AVDTemplate} [DeleteAllCreatedHosts (SwitchParameter)] [(CommonParameters)]

Remove-RASTemplate [Name] (string) [[-SiteId] (uint)] -ObjType {RDSTemplate | VDITemplate | AVDTemplate} [DeleteAllCreatedHosts (SwitchParameter)] [(CommonParameters)]

DESCRIPTION

The cmdlet removes a Template property.

PARAMETERS

Name (string)

The name of a RAS Template to remove from the site.

        Required?                    true

        Position?                    0

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

SiteId (uint)

Site ID from which to remove the specified RAS Template.

If the parameter is omitted, the site ID of the Licensing Server will be used.

        Required?                    false

        Position?                    1

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false

Id (uint)

The ID of the RAS Template to remove.

To obtain the ID of a RAS Template, use the Get-Template cmdlet.

        Required?                    true

        Position?                    0

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false

InputObject (Template)

An object of type RAS Template.

To obtain the object, use the Get-Template cmdlet.

        Required?                    true

        Position?                    0

        Default value                

        Accept pipeline input?       true (ByValue)

        Accept wildcard characters?  false

ObjType (Template)

Template object type.

Possible values: RDSTemplate, VDITemplate, AVDTemplate

        Required?                    true

        Position?                    named

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false

DeleteAllCreatedHosts (SwitchParameter)

Specifies whether to delete all created host VMs.

If this parameter is omitted, all created host VMs will be kept on the server.

        Required?                    false

        Position?                    named

        Default value                False

        Accept pipeline input?       false

        Accept wildcard characters?  false

(CommonParameters)

        This cmdlet supports the common parameters: Verbose, Debug,

        ErrorAction, ErrorVariable, WarningAction, WarningVariable,

        OutBuffer, PipelineVariable, and OutVariable. For more information, see 

        about_CommonParameters documentation. 

INPUTS

Template

OUTPUTS

-none-

EXAMPLES

**---------- EXAMPLE 1 ----------

Remove-RASTemplate -ObjType RDSTemplate -Name "My Template" | Format-List

Removes the RDS Template properties specified by name from the Licensing Server site. **---------- EXAMPLE 2 ----------

Get-RASTemplate -ObjType VDITemplate -Id 10

Removes VDI Template specified by ID from the Licensing Server site.

RELATED LINKS

• New-RASTemplate

• Set-RASTemplate

• Get-RASTemplate