New-RASVDIHostPool.md

NAME

New-RASVDIHostPool

SYNOPSIS

Creates a new VDI Host Pool.

SYNTAX

New-RASVDIHostPool [Name] (string) [[-SiteId] (uint)] -ProvisioningType {Template | Standalone} [-DatastoreIDs (string[])] [-DatastoreSource {Template | Selection}] [-DefaultPowerState {PoweredOn | PoweredOff | Suspended}] [Description (string)] [Duration (uint)] [Enabled (bool)] [HostName (string)] [HostsToCreate (uint)] [MaxHosts (uint)] [PreCreatedHosts (uint)] [TemplateId (uint)] [TemplateTagId (uint)] [TemplateVersionId (uint)] [(CommonParameters)]

DESCRIPTION

Creates a new VDI Host Pool. Individual members can be added to the VDI host pool using the Add-RASVDIHostPoolMember cmdlet.

PARAMETERS

Name (string)

The name of the target VDI Host Pool.

This must be the actual VDI Host Pool name used in the RAS farm.

        Required?                    true

        Position?                    0

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

SiteId (uint)

Site ID in which to modify the specified VDI Host Pool.

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

Description (string)

A user-defined VDI Host Pool description.

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

Enabled (bool)

Enable or disable the VDI Host Pool upon creation.

If the parameter is omitted, the VDI Host Pool is initialised as Disabled.

        Required?                    false

        Position?                    named

        Default value                False

        Accept pipeline input?       false

        Accept wildcard characters?  false

ProvisioningType

(ProvisioningType) The Host Pool Provisioning type

Possible values: Template, Standalone

        Required?                    true

        Position?                    named

        Default value                Template

        Accept pipeline input?       false

        Accept wildcard characters?  false

TemplateId (uint)

Template ID

        Required?                    false

        Position?                    named

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false

TemplateVersionId (uint)

Template Version ID

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

TemplateTagId (uint)

Template Tag ID

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

MaxHosts (uint)

The maximum number of hosts that can be created from the template.

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

PreCreatedHosts (uint)

The maximum pre-created hosts.

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

HostName (string)

The VM name format. All VMs created from the template will have this name with %ID:N:S% replaced.

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

DefaultPowerState

(DefaultPowerState) The Default Power State

Possible values: PoweredOn, PoweredOff, Suspended

        Required?                    false

        Position?                    named

        Default value                PoweredOn

        Accept pipeline input?       false

        Accept wildcard characters?  false

Duration (uint)

The Duration

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

HostsToCreate (uint)

The number of hosts that will be created after template creation process has finished. These desktops are created only once.

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

DatastoreSource

(DatastoreSourceType) Datastore Source.

Possible values: Template, Selection

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

DatastoreIDs (string[])

Datastore IDs.

        Required?                    false

        Position?                    named

        Default value                

        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

-none-

OUTPUTS

VDIHostPool

EXAMPLES

**---------- EXAMPLE 1 ----------

New-RASVDIHostPool "My VDI Host Pool"

Creates a new VDI Host Pool with the specified name.

RELATED LINKS

• Get-RASVDIHostPool

• Set-RASVDIHostPool

• Remove-RASVDIHostPool

• Add-RASVDIHostPoolMember

• Remove-RASVDIHostPoolMember