Add-VDIPoolMember

NAME

Add-VDIPoolMember

SYNOPSIS

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

SYNTAX

Add-VDIPoolMember [- VDIPoolName ] <string> [[- SiteId ] <uint> ] - Name <string> - Type < VDIPoolMemberType > {ALLGUESTINHOST | GUEST | NATIVEPOOL | TEMPLATEGUEST | UNKNOWN} [- NativePoolId <string> ] [- VDIGuestId <string> ] [- VDIHostId <uint> ] [- VDITemplateId <uint> ] [ < CommonParameters > ]

Add-VDIPoolMember [- VDIPoolId ] <uint> - Name <string> - Type < VDIPoolMemberType > {ALLGUESTINHOST | GUEST | NATIVEPOOL | TEMPLATEGUEST | UNKNOWN} [- NativePoolId <string> ] [- VDIGuestId <string> ] [- VDIHostId <uint> ] [- VDITemplateId <uint> ] [ < CommonParameters > ]

Add-VDIPoolMember [- InputObject ] < VDIPool > - Name <string> - Type < VDIPoolMemberType > {ALLGUESTINHOST | GUEST | NATIVEPOOL | TEMPLATEGUEST | UNKNOWN} [- NativePoolId <string> ] [- VDIGuestId <string> ] [- VDIHostId <uint> ] [- VDITemplateId <uint> ] [ < CommonParameters > ]

DESCRIPTION

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

PARAMETERS


- Type < VDIPoolMemberType >
The VDI Pool Member Type.

The type can either be: ALLGUESTINHOST, GUEST, NATIVEPOOL or TEMPLATEGUEST.

Possible values: ALLGUESTINHOST, GUEST, NATIVEPOOL, TEMPLATEGUEST, UNKNOWN

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

- Name <string>
The VDI Pool Member Name.

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

- VDIHostId <uint>
The VDI Pool Member Host ID.

This parameter is only accepted with Types: ALLGUESTINHOST, GUEST or NATIVEPOOL.

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

- VDIGuestId <string>
The VDI 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 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

- VDITemplateId <uint>
The VDI Pool Member Template ID.

This parameter is only accepted with Type: TEMPLATEGUEST.

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

- VDIPoolName <string>
The VDI Pool name.

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

- SiteId <uint>
Site ID where the VDI Pool is located.

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

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

- VDIPoolId <uint>
The VDI Pool ID.

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

- InputObject < VDIPool >
An object of type VDIPool identifying the target VDI Pool.

The object is obtained using the Get-VDIPool cmdlet.

        Required?                    true
        Position?                    0
        Default value                
        Accept pipeline input?       true (ByValue)
        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

VDIPool

OUTPUTS

-none-

EXAMPLES


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

Add-VDIPoolMember -VDIPoolName "My VDI Pool" -Type ALLGUESTINHOST -Name "MY VDI Pool Member" -VDIHostId 1

Adds the specified VDI Pool Member to the specified VDI Pool.

The Type ALLGUESTINHOST requires the VDIHostId to be specified.

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

Add-VDIPoolMember -VDIPoolName "My VDI Pool" -Type GUEST -Name "MY VDI Pool Member" -VDIHostId 1 -VDIGuestId 42312685-05c9-ca51-342d-b3943046edf1

Adds the specified VDI Pool Member to the specified VDI Pool.

The Type GUEST requires the VDIHostId and VDIGuestId to be specified.

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

Add-VDIPoolMember -VDIPoolName "My VDI Pool" -Type NATIVEPOOL -Name "MY VDI Pool Member" -VDIHostId 1 -NativePoolId 1

Adds the specified VDI Pool Member to the specified VDI Pool.

The Type NATIVEPOOL requires the VDIHostId and NativePoolId to be specified.

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

Add-VDIPoolMember -VDIPoolName "My VDI Pool" -Type TEMPLATEGUEST -Name "MY VDI Pool Member" -VDITemplateId 1

Adds the specified VDI Pool Member to the specified VDI Pool.

The Type TEMPLATEGUEST requires the VDITemplateId to be specified.

RELATED LINKS