Add-RASVDIHostPoolMember

NAME

SYNOPSIS

Adds one or multiple VDI Host Pool Members to a VDI Host Pool.

SYNTAX

Add-RASVDIHostPoolMember [-VDIHostPoolId] <uint> -Name <string> -Type {AllHostsInProvider | AllGuestsInProvider | Host | Guest | NativePool | Template | TemplateGuest | TemplateVersion} [-NativePoolId <string>] [-NoInstall <SwitchParameter>] [-ProviderId <uint>] [-VMId <string>] [-VMIds <List`1>] [<CommonParameters>] Add-RASVDIHostPoolMember [-VDIHostPoolId] <uint> -Name <string> -Password <SecureString> -Type {AllHostsInProvider | AllGuestsInProvider | Host | Guest | NativePool | Template | TemplateGuest | TemplateVersion} -Username <string> [-NativePoolId <string>] [-ProviderId <uint>] [-VMId <string>] [-VMIds <List`1>] [<CommonParameters>] Add-RASVDIHostPoolMember [-InputObject] <VDIHostPool> -Name <string> -Type {AllHostsInProvider | AllGuestsInProvider | Host | Guest | NativePool | Template | TemplateGuest | TemplateVersion} [-NativePoolId <string>] [-NoInstall <SwitchParameter>] [-ProviderId <uint>] [-VMId <string>] [-VMIds <List`1>] [<CommonParameters>] Add-RASVDIHostPoolMember [-InputObject] <VDIHostPool> -Name <string> -Password <SecureString> -Type {AllHostsInProvider | AllGuestsInProvider | Host | Guest | NativePool | Template | TemplateGuest | TemplateVersion} -Username <string> [-NativePoolId <string>] [-ProviderId <uint>] [-VMId <string>] [-VMIds <List`1>] [<CommonParameters>] Add-RASVDIHostPoolMember [-VDIHostPoolName] <string> [[-SiteId] <uint>] -Name <string> -Type {AllHostsInProvider | AllGuestsInProvider | Host | Guest | NativePool | Template | TemplateGuest | TemplateVersion} [-NativePoolId <string>] [-NoInstall <SwitchParameter>] [-ProviderId <uint>] [-VMId <string>] [-VMIds <List`1>] [<CommonParameters>] Add-RASVDIHostPoolMember [-VDIHostPoolName] <string> [[-SiteId] <uint>] -Name <string> -Password <SecureString> -Type {AllHostsInProvider | AllGuestsInProvider | Host | Guest | NativePool | Template | TemplateGuest | TemplateVersion} -Username <string> [-NativePoolId <string>] [-ProviderId <uint>] [-VMId <string>] [-VMIds <List`1>] [<CommonParameters>]

DESCRIPTION

Adds one or multiple VDI Host Pool Members to an existing VDI Host Pool.

PARAMETERS

-VDIHostPoolName <string> The VDI Host Pool name.

        Required?                    true

        Position?                    0

        Default value

        Accept pipeline input?       false

        Accept wildcard characters?  false

-SiteId <uint> Site ID where the VDI Host Pool is located. 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

-VDIHostPoolId <uint> The VDI Host Pool ID.

        Required?                    true

        Position?                    0

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false

-InputObject <VDIHostPool> An object of type VDIHostPool identifying the target VDI Host Pool. The object is obtained using the Get-RASVDIHostPool cmdlet.

        Required?                    true

        Position?                    0

        Default value

        Accept pipeline input?       true (ByValue)

        Accept wildcard characters?  false

-Type <VDIHostPool> The VDI Host Pool Member Type. The type can either be: ALLGUESTSINPROVIDER, GUEST, NATIVEPOOL, TEMPLATEGUEST or TEMPLATEVERSION. Possible values: AllHostsInProvider, AllGuestsInProvider, Host, Guest, NativePool, Template, TemplateGuest, TemplateVersion

        Required?                    true

        Position?                    named

        Default value                AllGuestsInProvider

        Accept pipeline input?       false

        Accept wildcard characters?  false

-Name <string> The VDI Host Pool Member Name.

        Required?                    true

        Position?                    named

        Default value

        Accept pipeline input?       false

        Accept wildcard characters?  false

-ProviderId <uint> The VDI Host Pool Member Provider ID. This parameter is only accepted with Types: ALLGUESTSONPROVIDER, GUEST or NATIVEPOOL.

        Required?                    false

        Position?                    named

        Default value

        Accept pipeline input?       false

        Accept wildcard characters?  false

-VMId <string> The VDI Host Pool Member Guest ID. This parameter is only accepted with Type: GUEST.

        Required?                    false

        Position?                    named

        Default value

        Accept pipeline input?       false

        Accept wildcard characters?  false

-NativePoolId <string> The VDI Host Pool Member Native Pool ID. This parameter is only accepted with Type: NATIVEPOOL.

        Required?                    false

        Position?                    named

        Default value

        Accept pipeline input?       false

        Accept wildcard characters?  false

-NoInstall <SwitchParameter> Specifies not to install the RAS Guest Agent on the server. If this parameter is omitted, the agent will be push installed in the VM using your RAS admin credentials. To specify different credentials for push installation, use the Username and Password parameters. This parameter can be used in situations when the RAS Guest Agent is already installed in a VM, but the VM is powered down. By including this parameter, you will simply power up the VM and make it available for Parallels RAS operations.

        Required?                    false

        Position?                    named

        Default value                False

        Accept pipeline input?       false

        Accept wildcard characters?  false

-Username <string> An administrator account for push installing the RAS Guest Agent in the VM. If this parameter is omitted, your RAS admin username (and password) will be used.

        Required?                    true

        Position?                    named

        Default value

        Accept pipeline input?       false

        Accept wildcard characters?  false

-Password <SecureString> The password of the account specified in the Username parameter.

        Required?                    true

        Position?                    named

        Default value

        Accept pipeline input?       false

        Accept wildcard characters?  false

-VMIds <List`1> The VDI Host Pool Member Desktops IDs. This parameter is only accepted with Type: ALLDESKTOPSONPROVIDER.

        Required?                    false

        Position?                    named

        Default value                System.Collections.Generic.List`1[System.String]

        Accept pipeline input?       false

        Accept wildcard characters?  false

        This cmdlet supports the common parameters: Verbose, Debug,

        ErrorAction, ErrorVariable, WarningAction, WarningVariable,

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

        about_CommonParameters .

INPUTS

VDIHostPool

OUTPUTS

-none-

EXAMPLES

---------- EXAMPLE 1 ---------- Add-RASVDIHostPoolMember -VDIHostPoolName "My VDI Host Pool" -Type ALLGUESTSONPROVIDER -Name "MY VDI Host Pool Member" -ProviderId 1 Adds the specified VDI Host Pool Member to the specified VDI Host Pool. The Type ALLGUESTSONPROVIDER requires the ProviderId to be specified. ---------- EXAMPLE 2 ---------- Add-RASVDIHostPoolMember -VDIHostPoolName "My VDI Host Pool" -Type GUEST -Name "MY VDI Host Pool Member" -ProviderId 1 -VMId 42312685-05c9-ca51-342d-b3943046edf1 Adds the specified VDI Host Pool Member to the specified VDI Host Pool. The Type GUEST requires the ProviderId and VDIDesktopId to be specified. ---------- EXAMPLE 3 ---------- Add-RASVDIHostPoolMember -VDIHostPoolName "My VDI Host Pool" -Type NATIVEPOOL -Name "MY VDI Host Pool Member" -ProviderId 1 -NativePoolId 1 Adds the specified VDI Host Pool Member to the specified VDI Host Pool. The Type NATIVEPOOL requires the ProviderId and NativePoolId to be specified. ---------- EXAMPLE 4 ---------- Add-RASVDIHostPoolMember -VDIHostPoolName "My VDI Host Pool" -Type TEMPLATEDESKTOP -Name "MY VDI Host Pool Member" -VDITemplateId 1 Adds the specified VDI Host Pool Member to the specified VDI Host Pool. The Type TEMPLATEGUEST requires the VDITemplateId to be specified.

PreviousAdd-RASURLRedirectionEntry NextAdd-RASWinDeviceGroupInboundPort

Last updated 8 months ago