# RDSHostPool

## NAMESPACE

RASAdminEngine.Core.OutputModels

## DESCRIPTION

RDS Host Pool

## INHERITED FROM

[RASSerilazableObj](https://docs.parallels.com/landing/ras-powershell-api-guide/parallels-ras-powershell-admin-module/types/rasserilazableobj)

⇒

[RASListObj](https://docs.parallels.com/landing/ras-powershell-api-guide/parallels-ras-powershell-admin-module/types/raslistobj)

⇒

RDSHostPool

## INTERFACES

* ISerializable
* IComparable

## PUBLIC PROPERTIES

| Type                                                                                                                                                         | Name                                | Description                                                                                                                                                                             |
| ------------------------------------------------------------------------------------------------------------------------------------------------------------ | ----------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| String                                                                                                                                                       | AdminCreate                         | Inherited from [RASListObj](https://docs.parallels.com/landing/ras-powershell-api-guide/parallels-ras-powershell-admin-module/types/raslistobj) User who created the object.            |
| String                                                                                                                                                       | AdminLastMod                        | Inherited from [RASListObj](https://docs.parallels.com/landing/ras-powershell-api-guide/parallels-ras-powershell-admin-module/types/raslistobj) User who last modified the object.      |
| Boolean                                                                                                                                                      | Autoscale                           | Whether the RD session hosts are based on a template or not.                                                                                                                            |
| String                                                                                                                                                       | Description                         | Description of the RDS Host Pool.                                                                                                                                                       |
| UInt32                                                                                                                                                       | DrainRemainsBelowSec                | Drain and unassign servers from host pool when workload remains below the specified level for the specified time (in seconds).                                                          |
| Boolean                                                                                                                                                      | Enabled                             | Whether the RDS Host Pool is enabled or not.                                                                                                                                            |
| UInt32                                                                                                                                                       | Id                                  | ID of the object.                                                                                                                                                                       |
| Boolean                                                                                                                                                      | InheritDefaultAgentSettings         | If true, default agent settings will be inherited.                                                                                                                                      |
| Boolean                                                                                                                                                      | InheritDefaultAppPackageSettings    | If true, default app package settings will be inherited.                                                                                                                                |
| Boolean                                                                                                                                                      | InheritDefaultAutoUpgradeSettings   | If true, default Auto-upgrade settings will be inherited.                                                                                                                               |
| Boolean                                                                                                                                                      | InheritDefaultDesktopAccessSettings | If true, default desktop access settings will be inherited.                                                                                                                             |
| Boolean                                                                                                                                                      | InheritDefaultPrinterSettings       | If true, default printer settings will be inherited.                                                                                                                                    |
| Boolean                                                                                                                                                      | InheritDefaultUserProfileSettings   | If true, default User Profile settings will be inherited.                                                                                                                               |
| UInt32                                                                                                                                                       | MaxServersFromTemplate              | Max number of servers to be added to the host pool from the template.                                                                                                                   |
| UInt32                                                                                                                                                       | MinServersFromTemplate              | Min number of servers to be added to the host pool from the template.                                                                                                                   |
| String                                                                                                                                                       | Name                                | RDS Host Pool name.                                                                                                                                                                     |
| [HostPoolProviderSettings](https://docs.parallels.com/landing/ras-powershell-api-guide/parallels-ras-powershell-admin-module/types/hostpoolprovidersettings) | ProviderSettings                    | Contains the Settings which relate to the Provider.                                                                                                                                     |
| UInt32                                                                                                                                                       | RASTemplateId                       | The RDSH RAS Template ID.                                                                                                                                                               |
| UInt32                                                                                                                                                       | RASTemplateVersionId                | The RDSH RAS Template Version ID.                                                                                                                                                       |
| [RDSDefaultSettings](https://docs.parallels.com/landing/ras-powershell-api-guide/parallels-ras-powershell-admin-module/types/rdsdefaultsettings)             | RDSDefSettings                      | The RDS Settings. List\<UInt32> RDSIds The Ids of the RDS that form part of the host pool.                                                                                              |
| [ProvisioningSettings](https://docs.parallels.com/landing/ras-powershell-api-guide/parallels-ras-powershell-admin-module/types/provisioningsettings)         | RDSProvisioningSettings             | Specifies the 'Provisioning' object.                                                                                                                                                    |
| Boolean                                                                                                                                                      | RemoveServersAfterDrainAndPowerOff  | Remove servers from host pool after drain and power off.                                                                                                                                |
| UInt32                                                                                                                                                       | ServersToAddPerRequest              | Number of servers to be added to the host pool per request.                                                                                                                             |
| UInt32                                                                                                                                                       | SiteId                              | ID of the site.                                                                                                                                                                         |
| [TemplateSettings](https://docs.parallels.com/landing/ras-powershell-api-guide/parallels-ras-powershell-admin-module/types/templatesettings)                 | TemplateSettings                    | Specifies the 'Template' object.                                                                                                                                                        |
| DateTime                                                                                                                                                     | TimeCreate                          | Inherited from [RASListObj](https://docs.parallels.com/landing/ras-powershell-api-guide/parallels-ras-powershell-admin-module/types/raslistobj) Time when the object was created.       |
| DateTime                                                                                                                                                     | TimeLastMod                         | Inherited from [RASListObj](https://docs.parallels.com/landing/ras-powershell-api-guide/parallels-ras-powershell-admin-module/types/raslistobj) Time when the object was last modified. |
| UInt32                                                                                                                                                       | WorkLoadThreshold                   | Send a request to the template when the threshold is above the specified value (%).                                                                                                     |
| UInt32                                                                                                                                                       | WorkLoadToDrain                     | Drain and unassign servers from host pool when workload is below the specified value (%).                                                                                               |

## PUBLIC METHODS

| Type                                                                                                                                                                          | Name                       | Description                                                                                                                                                   |
| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Int32                                                                                                                                                                         | CompareTo (Object obj)     | Inherited from [RASSerilazableObj](https://docs.parallels.com/landing/ras-powershell-api-guide/parallels-ras-powershell-admin-module/types/rasserilazableobj) |
| Boolean                                                                                                                                                                       | Equals (Object obj)        | Inherited from [RASSerilazableObj](https://docs.parallels.com/landing/ras-powershell-api-guide/parallels-ras-powershell-admin-module/types/rasserilazableobj) |
| Int32                                                                                                                                                                         | GetHashCode ()             | Inherited from [RASSerilazableObj](https://docs.parallels.com/landing/ras-powershell-api-guide/parallels-ras-powershell-admin-module/types/rasserilazableobj) |
| Type                                                                                                                                                                          | GetType ()                 | String                                                                                                                                                        |
| ToString ()                                                                                                                                                                   | ### References to Commands |                                                                                                                                                               |
| ------------------------------------------------------------------------                                                                                                      |                            |                                                                                                                                                               |
| [Get-RASRDSHostPoolStatus](https://github.com/Parallels-Corp/TEST-docs/blob/LatestDoc/21_Release/20_RAS_21_API_Guides/PS_API/MD/RASAdmin/cmdlets/Get-RASRDSHostPoolStatus.md) |                            |                                                                                                                                                               |
| [New-RASPubRDSApp](https://github.com/Parallels-Corp/TEST-docs/blob/LatestDoc/21_Release/20_RAS_21_API_Guides/PS_API/MD/RASAdmin/cmdlets/New-RASPubRDSApp.md)                 |                            |                                                                                                                                                               |
| [Remove-RASRDSHostPool](https://github.com/Parallels-Corp/TEST-docs/blob/LatestDoc/21_Release/20_RAS_21_API_Guides/PS_API/MD/RASAdmin/cmdlets/Remove-RASRDSHostPool.md)       |                            |                                                                                                                                                               |
