Remove-VDITemplate

NAME

Remove-VDITemplate

SYNOPSIS

Removes a RAS Template from a site.

SYNTAX

Remove-VDITemplate [-Name] <string> [[-SiteId] <uint>] [-DeleteAllCreatedGuests <SwitchParameter>] [<CommonParameters>]

Remove-VDITemplate [-Id] <uint> [-DeleteAllCreatedGuests <SwitchParameter>] [<CommonParameters>]

Remove-VDITemplate [-InputObject] <VDITemplate> [-DeleteAllCreatedGuests <SwitchParameter>] [<CommonParameters>]

DESCRIPTION

Removes a specified RAS Template from a site.

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-VDITemplate cmdlet. 

        Required?                    true
        Position?                    0
        Default value                0
        Accept pipeline input?       false
        Accept wildcard characters?  false

-InputObject <VDITemplate>
An object of type VDITemplate representing a RAS Template.

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

        Required?                    true
        Position?                    0
        Default value                
        Accept pipeline input?       true (ByValue)
        Accept wildcard characters?  false

-DeleteAllCreatedGuests <SwitchParameter>
Specifies whether to delete all created guest VMs.

If this parameter is omitted, all created guest 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

VDITemplate

OUTPUTS

-none-

EXAMPLES


---------- EXAMPLE 1 ----------

Remove-VDITemplate "TemplateName"

Removes the specified RAS Template from the Licensing Server site.

Since -DeleteAllCreatedGuests is not passed, all created guest VMs will be kept on the server.

---------- EXAMPLE 2 ----------

Remove-VDITemplate -Id 10 -DeleteAllCreatedGuests

Removes a RAS Template specified by ID.

Since -DeleteAllCreatedGuests is passed, all created guest VMs will be removed from the server.

---------- EXAMPLE 3 ----------

Remove-VDITemplate -InputObject $Template -DeleteAllCreatedGuests

Removes a RAS Template specified by the $Template object.

Since -DeleteAllCreatedGuests is passed, all created guest VMs will be removed from the server.

---------- EXAMPLE 4 ----------

Get-VDITemplate -Id 10 | Remove-VDITemplate -DeleteAllCreatedGuests

Removes a RAS Template specified by an object obtained from the pipeline output.

Since -DeleteAllCreatedGuests is passed, all created guest VMs will be removed from the server.

RELATED LINKS