New-RASVDIHostPool
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)] [DeviceName (string)] [DomainOrgUnit (string)] [Duration (uint)] [Enabled (bool)] [HostName (string)] [HostsToCreate (uint)] [MaxHosts (uint)] [MaximumIOPS (ulong)] [OverrideStorage (bool)] [OverrideVirtualNetwork (bool)] [OverwriteSize (bool)] [PreCreatedHosts (uint)] [Size (uint)] [TemplateId (uint)] [TemplateTagId (uint)] [TemplateVersionId (uint)] [Throughput (ulong)] [VMSize (string)] [VolumeType {gp2 | gp3 | io1 | io2 | standard}] [(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.
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.
Description (string)
A user-defined VDI Host Pool description.
Enabled (bool)
Enable or disable the VDI Host Pool upon creation.
If the parameter is omitted, the VDI Host Pool is initialised as Disabled.
ProvisioningType (ProvisioningType)
The Host Pool Provisioning type
Possible values: Template, Standalone
TemplateId (uint)
Template ID
TemplateVersionId (uint)
Template Version ID
TemplateTagId (uint)
Template Tag ID
MaxHosts (uint)
The maximum number of hosts that can be created from the template.
PreCreatedHosts (uint)
The maximum pre-created hosts.
HostName (string)
The VM name format. All VMs created from the template will have this name with %ID:N:S% replaced.
DefaultPowerState (DefaultPowerState)
The Default Power State
Possible values: PoweredOn, PoweredOff, Suspended
Duration (uint)
The Duration
HostsToCreate (uint)
The number of hosts that will be created after template creation process has finished. These desktops are created only once.
DatastoreSource (DatastoreSourceType)
Datastore Source.
Possible values: Template, Selection
DatastoreIDs (string[])
Datastore IDs.
OverrideStorage (bool)
Specifications: Whether Override Storage is Enabled or not. (Override Storage)
Available to Azure/AWS
OverrideVirtualNetwork (bool)
Specifications: Whether Override Virtual Network is Enabled or not. (Override Virtual Network)
Available to Azure/AWS
OverwriteSize (bool)
Specifications: Whether Overwrite Size is Enabled or not.
Available to Templated Host Pools
VMSize (string)
Specifications: VMSize which will override the size specified in template properties.
Example: Standard_B2s
DeviceName (string)
Device name. (Available for AWS Provider)
VolumeType (VolumeType)
Volume type. (Available for AWS Provider)
Possible values: gp2, gp3, io1, io2, standard
Size (uint)
Size (GiB). (Available for AWS Provider)
MaximumIOPS (ulong)
Maximum IOPS. (Available for AWS Provider)
Throughput (ulong)
Throughput (MB/s). (Available for AWS Provider)
DomainOrgUnit (string)
Domain Organization unit
(CommonParameters)
INPUTS
-none-
OUTPUTS
---------- EXAMPLE 1 ----------
New-RASVDIHostPool "My VDI Host Pool"
Creates a new VDI Host Pool with the specified name.
RELATED LINKS
Last updated