New-PubVDIApp

NAME

New-PubVDIApp

SYNOPSIS

Adds a published VDI application to a site.

SYNTAX

New-PubVDIApp [-Name] <string> -Target <string> [-ConnectTo <VDIMatchingMode> {AnyGuest | SpecificGuest | Guest | SpecificRASTemplate}] [-Description <string>] [-Enable <bool>] [-Icon <string>] [-IconIndex <uint>] [-NameRule <VDINameRule> {Username | IPAddress}] [-Parameters <string>] [-ParentFolder <PubFolder>] [-Persistent <bool>] [-PoolId <uint>] [-PublishToSite <Site[]>] [-SiteId <uint>] [-StartIn <string>] [-StartOnLogon <SwitchParameter>] [-VDIGuest <VDIGuest>] [-VDITemplate <VDITemplate>] [-WinType <WindowType> {Normal | Maximized | Minimized}] [<CommonParameters>]

DESCRIPTION

Adds a published VDI application to a site.

You must specify the -Name and -Target parameters. All other parameters are optional.

PARAMETERS


-Persistent <bool>
Specifies whether the connection is persistent or not.

        Required?                    false
        Position?                    named
        Default value                True
        Accept pipeline input?       false
        Accept wildcard characters?  false

-ConnectTo <VDIMatchingMode>
Specifies the 'Matching Mode' option to connect with.

Acceptable values: 0 (Any Guest), 1 (Specific Guest), 2 (Guest), 3 (Specific RAS Template).

Possible values: AnyGuest, SpecificGuest, Guest, SpecificRASTemplate

        Required?                    false
        Position?                    named
        Default value                AnyGuest
        Accept pipeline input?       false
        Accept wildcard characters?  false

-NameRule <VDINameRule>
Specifies the 'Name Rule' option.

Acceptable values: 0 (Username), 1 (IP Address).

Possible values: Username, IPAddress

        Required?                    false
        Position?                    named
        Default value                Username
        Accept pipeline input?       false
        Accept wildcard characters?  false

-PoolId <uint>
Specifies the VDI Pool from which to publish an application.

        Required?                    false
        Position?                    named
        Default value                1
        Accept pipeline input?       false
        Accept wildcard characters?  false

-VDIGuest <VDIGuest>
Specifies the guest VM from which to publish an application.

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

-VDITemplate <VDITemplate>
Specifies the RAS Template from which to publish an application.

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

-Target <string>
File name and path of a published application executable.

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

-Parameters <string>
Optional parameters to pass to the published application executable.

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

-StartIn <string>
Folder name in which to start a published application.

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

-StartOnLogon <SwitchParameter>
Enables or disables the 'Start automatically when user logs on' option.

        Required?                    false
        Position?                    named
        Default value                False
        Accept pipeline input?       false
        Accept wildcard characters?  false

-WinType <WindowType>
Published application window type. Acceptable values: 0 (Normal), 1 (Maximized), 2 (Minimized)

Possible values: Normal, Maximized, Minimized

        Required?                    false
        Position?                    named
        Default value                Normal
        Accept pipeline input?       false
        Accept wildcard characters?  false

-Name <string>
Published resource name.

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

-ParentFolder <PubFolder>
Parent publishing folder name.

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

-Icon <string>
An icon to use for a publishing resource.

This can be an executable or a .dll file.

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

-IconIndex <uint>
Icon index

Specifies the index of the icon that will be loaded from the binary specified in the Icon property.

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

-Enable <bool>
Enable or disable a published resource.

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

-Description <string>
Published resource description.

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

-PublishToSite <Site[]>
An array of sites to which to publish a resource.

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

-SiteId <uint>
Site ID.

        Required?                    false
        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 (http://go.microsoft.com/fwlink/?LinkID=113216). 

INPUTS

PSAdmin.PubFolder

        Parent publishing folder name.

OUTPUTS

PSAdmin.PubVDIApp

EXAMPLES


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

New-PubVDIApp -Name "My VDI App" -Target "%windir%\system32\myapp.exe"

Adds a published application to the Licensing Server site and specifies the app name and executable.

RELATED LINKS

Parallels RAS v16.0