> For the complete documentation index, see [llms.txt](https://docs.parallels.com/landing/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.parallels.com/landing/ras-powershell-api-guide/parallels-ras-powershell-admin-module/types/halbsettings.md).

# HALBSettings

## NAMESPACE

RASAdminEngine.Core.OutputModels

## DESCRIPTION

HALB Virtual Server settings

## INHERITED FROM

[RASSerilazableObj](/landing/ras-powershell-api-guide/parallels-ras-powershell-admin-module/types/rasserilazableobj.md)

⇒

[RASListObj](/landing/ras-powershell-api-guide/parallels-ras-powershell-admin-module/types/raslistobj.md)

⇒

HALBSettings

## INTERFACES

* ISerializable
* IComparable

## PUBLIC PROPERTIES

| Type                                                                                                                                                | Name                       | Description                                                                                                                                                                 |
| --------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| String                                                                                                                                              | AdminCreate                | Inherited from [RASListObj](/landing/ras-powershell-api-guide/parallels-ras-powershell-admin-module/types/raslistobj.md) User who created the object.                       |
| String                                                                                                                                              | AdminLastMod               | Inherited from [RASListObj](/landing/ras-powershell-api-guide/parallels-ras-powershell-admin-module/types/raslistobj.md) User who last modified the object.                 |
| [LoadBalancingAlgorithm](/landing/ras-powershell-api-guide/parallels-ras-powershell-admin-module/types/loadbalancingalgorithm.md)                   | Algorithm                  | Load balancing algorithm                                                                                                                                                    |
| UInt32                                                                                                                                              | ClientIdleTimeout          | Client inactivity timeout                                                                                                                                                   |
| [HALBClientManagerConfigSettings](/landing/ras-powershell-api-guide/parallels-ras-powershell-admin-module/types/halbclientmanagerconfigsettings.md) | ClientManagementConfig     | HALB Device Manager configuration settings                                                                                                                                  |
| UInt32                                                                                                                                              | ClientQueueTimeout         | Client connection queue timeout                                                                                                                                             |
| String                                                                                                                                              | Description                | Appliance description. List<[HALBDevice](/landing/ras-powershell-api-guide/parallels-ras-powershell-admin-module/types/halbdevice.md)> Devices A collection of HALB Devices |
| Boolean                                                                                                                                             | EnableDeviceManagement     | Whether the Device Management is enabled or not.                                                                                                                            |
| Boolean                                                                                                                                             | EnableGatewayPayload       | Whether the Gateway payload is enabled or not.                                                                                                                              |
| Boolean                                                                                                                                             | EnableHALBInstance         | Whether the HALB instance is enabled or not.                                                                                                                                |
| Boolean                                                                                                                                             | EnableSSLPayload           | Whether the SSL payload is enabled or not.                                                                                                                                  |
| Boolean                                                                                                                                             | EnableUDPTunneling         | Whether RDP UDP tunneling is enabled or not.                                                                                                                                |
| [HALBGatewayConfigSettings](/landing/ras-powershell-api-guide/parallels-ras-powershell-admin-module/types/halbgatewayconfigsettings.md)             | GatewayConfig              | HALB Gateway configuration settings                                                                                                                                         |
| UInt32                                                                                                                                              | GatewayConnectionTimeout   | Gateway connection timeout                                                                                                                                                  |
| UInt32                                                                                                                                              | GatewayHealthCheckInterval | Gateways health check intervals                                                                                                                                             |
| UInt32                                                                                                                                              | GatewayIdleTimeout         | Gateway inactivity timeout                                                                                                                                                  |
| UInt32                                                                                                                                              | Id                         | ID of the object.                                                                                                                                                           |
| [IPVersion](/landing/ras-powershell-api-guide/parallels-ras-powershell-admin-module/types/ipversion.md)                                             | IPVersion                  | IP Version (Version 4, Version 6 or Both Versions).                                                                                                                         |
| Boolean                                                                                                                                             | KeepLBProxyConfig          | Keep existing load balancing settings                                                                                                                                       |
| Boolean                                                                                                                                             | KeepVRRPConfig             | Keep existing VRRP/keepalived setting                                                                                                                                       |
| UInt32                                                                                                                                              | MaxTCPConnections          | Maximum number of TCP connections.                                                                                                                                          |
| String                                                                                                                                              | Name                       | Appliance name.                                                                                                                                                             |
| UInt32                                                                                                                                              | PrefixIPV6                 | Prefix for IP Version 6                                                                                                                                                     |
| String                                                                                                                                              | PublicAddress              | The Public Address of the HALB.                                                                                                                                             |
| UInt32                                                                                                                                              | SessionsRate               | Amount of TCP connections per second                                                                                                                                        |
| UInt32                                                                                                                                              | SiteId                     | The site ID of this HALB Virtual Server.                                                                                                                                    |
| [HALBSSLConfigSettings](/landing/ras-powershell-api-guide/parallels-ras-powershell-admin-module/types/halbsslconfigsettings.md)                     | SSLConfig                  | HALB SSL configuration settings                                                                                                                                             |
| String                                                                                                                                              | SubNetMask                 | SubNet Mask                                                                                                                                                                 |
| DateTime                                                                                                                                            | TimeCreate                 | Inherited from [RASListObj](/landing/ras-powershell-api-guide/parallels-ras-powershell-admin-module/types/raslistobj.md) Time when the object was created.                  |
| DateTime                                                                                                                                            | TimeLastMod                | Inherited from [RASListObj](/landing/ras-powershell-api-guide/parallels-ras-powershell-admin-module/types/raslistobj.md) Time when the object was last modified.            |
| String                                                                                                                                              | VirtualIPV4                | Virtual IP Version 4                                                                                                                                                        |
| String                                                                                                                                              | VirtualIPV6                | Virtual IP Version 6                                                                                                                                                        |
| UInt32                                                                                                                                              | VirtualRouterID            | VRRP virtual router ID                                                                                                                                                      |
| UInt32                                                                                                                                              | VrrpAdvertInterval         | VRRP advertisement interval                                                                                                                                                 |
| UInt32                                                                                                                                              | VrrpBroadcastInterval      | VRRP broadcast interval                                                                                                                                                     |
| UInt32                                                                                                                                              | VrrpHealthCheckInterval    | VRRP health script check interval                                                                                                                                           |
| UInt32                                                                                                                                              | VrrpHealthCheckTimeout     | VRRP health script check timeout                                                                                                                                            |

## PUBLIC METHODS

| Type                                                                                                                                               | Name                       | Description                                                                                                                            |
| -------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------- | -------------------------------------------------------------------------------------------------------------------------------------- |
| Int32                                                                                                                                              | CompareTo (Object obj)     | Inherited from [RASSerilazableObj](/landing/ras-powershell-api-guide/parallels-ras-powershell-admin-module/types/rasserilazableobj.md) |
| Boolean                                                                                                                                            | Equals (Object obj)        | Inherited from [RASSerilazableObj](/landing/ras-powershell-api-guide/parallels-ras-powershell-admin-module/types/rasserilazableobj.md) |
| Int32                                                                                                                                              | GetHashCode ()             | Inherited from [RASSerilazableObj](/landing/ras-powershell-api-guide/parallels-ras-powershell-admin-module/types/rasserilazableobj.md) |
| Type                                                                                                                                               | GetType ()                 | String                                                                                                                                 |
| ToString ()                                                                                                                                        | ### References to Commands |                                                                                                                                        |
| ------------------------------------------------------------------------                                                                           |                            |                                                                                                                                        |
| [New-RASHALB](https://github.com/Parallels-Corp/DI-OPS-prls-docs/blob/master/ras/API-guides/v21-PowerShell-API/MD/RASAdmin/cmdlets/New-RASHALB.md) |                            |                                                                                                                                        |


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.parallels.com/landing/ras-powershell-api-guide/parallels-ras-powershell-admin-module/types/halbsettings.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
