Get-RASTemplateStatus

NAME

Get-RASTemplateStatus

SYNOPSIS

Retrieves the status of a RAS Template.

SYNTAX

Get-RASTemplateStatus [[-Id] <uint>] -ObjType {RDSTemplate | VDITemplate | AVDTemplate} [<CommonParameters>] Get-RASTemplateStatus [[-InputObject] <Template>] -ObjType {RDSTemplate | VDITemplate | AVDTemplate} [<CommonParameters>] Get-RASTemplateStatus [[-Name] <string>] [[-SiteId] <uint>] -ObjType {RDSTemplate | VDITemplate | AVDTemplate} [<CommonParameters>]

DESCRIPTION

Retrieves the status of a RAS Template.

PARAMETERS

-Name <string> The name of the VDI Template for which to retrieve the information.

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

-Id <uint> The ID of the VDI Template. To obtain the ID, use the Get-Template cmdlet.

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

-SiteId <uint> Site ID from which to retrieve the specified VDI Template status information. 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

-InputObject <Template> An object of type Template representing the VDI Template. To obtain the object, use the Get-Template cmdlet.

        Required?                    false
        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

<CommonParameters>

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

INPUTS

Template

OUTPUTS

TemplateStatus

EXAMPLES

---------- EXAMPLE 1 ---------- Get-RASTemplateStatus -ObjType VDITemplate -Name "My Template" | Format-List Retrieves the status of the RAS VDI Template specified by name. The Format-List cmdlet formats the display output to include all available properties. ---------- EXAMPLE 2 ---------- Get-RASTemplateStatus -ObjType VDITemplate -Id 2 | Format-List Retrieve the status of the RAS VDI Template with ID 2. The Format-List cmdlet formats the display output to include the complete list of the returned properties.

Last updated

© 2024 Parallels International GmbH. All rights reserved.