> 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/rasadmin/cmdlets/new-rashalb.md).

# New-RASHALB

## SYNOPSIS

Creates a new instance of the HALB Virtual server settings.

## SYNTAX

```powershell
New-RASHALB [-Name] <string> [[-SiteId] <uint>] [[-LBGateways] <List`1>] [[-LBGatewayPort] <uint>]
 [[-EnableSSLPayload] <SwitchParameter>] [[-SSLMode] {SSLOffloading | SSLPassthrough}]
 [[-LBSSLGateways] <List`1>] [[-LBSSLGatewayPort] <uint>]
 [[-AcceptedSSLVersion] {TLSv1 | TLSv1_1 | TLSv1_2 | TLSv1_3}]
 [[-CipherStrength] {Low | Medium | High | Custom}] [[-SSLCustomCipher] <string>]
 [[-CertificateID] <uint>] [[-Description] <string>] [[-EnableDeviceManagement] <SwitchParameter>]
 [[-DeviceManagerGateways] <List`1>] [-IPVersion] {Version4 | Version6 | BothVersions}
 [[-VirtualIPv4] <string>] [[-SubnetMask] <string>] [[-VirtualIPv6] <string>] [[-PrefixIPV6] <uint>]
 [[-DeviceIPs] <List`1>] [[-EnableGatewayPayload] <SwitchParameter>] [-CipherPreference <bool>]
 [-ClientIdleTimeout <uint>] [-ClientQueueTimeout <uint>] [-EnableTunneling <bool>]
 [-GatewayConnectionTimeout <uint>] [-GatewayHealthCheckIntervals <uint>]
 [-GatewayIdleTimeout <uint>] [-KeepLBProxyConfig <bool>] [-KeepVRRPConfig <bool>]
 [-MaxTCPConnections <uint>] [-NoInstall <SwitchParameter>] [-PublicAddress <string>]
 [-SessionRate <uint>] [-VRRPAdvertisementInterval <uint>]
 [-VRRPAuthenticationPassword <SecureString>] [-VRRPBroadcastInterval <uint>]
 [-VRRPHealthScriptCheckInterval <uint>] [-VRRPHealthScriptCheckTimeout <uint>]
 [-VRRPVirtualRouterID <uint>] [<CommonParameters>]
```

## DESCRIPTION

Can also intialize the HALB Devices that were specified.

## EXAMPLES

### Example 1

```powershell
New-RASHALB -Name "HALB-VirtualServer" -IPVersion Version4 -VirtualIPv4 "1.2.3.4" -SubnetMask "255.255.255.0" -DeviceIPs @("4.3.2.1", "1.2.1.2") -NoInstall
```

To add the HALB Virtual Server to a specific site, add the -SiteId parameter.

## PARAMETERS

### -Name

The HALB Virtual Server name.

```yaml
Type: string
Required: True
Position: 0
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```

### -SiteId

The site ID where the HALB settings will be created.

```yaml
Type: uint
Required: False
Position: 1
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```

### -IPVersion

The supported IP versions of the HALB Virtual Server.

Possible values: Version4, Version6, BothVersions

Type reference: [IPVersion](https://docs.parallels.com/landing/ras-powershell-api-guide/rasadmin/types/ipversion.md)

```yaml
Type: IPVersion
Required: True
Position: 3
Default value: Version4
Accept pipeline input: False
Accept wildcard characters: False
```

### -DeviceIPs

The list of the HALB Device IPs.

```yaml
Type: List`1
Required: False
Position: 8
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```

### -EnableGatewayPayload

Enable/Disable the Non-SSL Gateway configuration of the HALB Virtual Server .

```yaml
Type: SwitchParameter
Required: False
Position: 9
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
```

### -EnableSSLPayload

Enable/Disable the SSL Gateway configuration of the HALB Virtual Server.

```yaml
Type: SwitchParameter
Required: False
Position: 12
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
```

### -EnableDeviceManagement

Enable/Disable the Device Management configuration of the HALB Virtual Server.

```yaml
Type: SwitchParameter
Required: False
Position: 20
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
```

### -NoInstall

If the switch is set, HALB Devices will not be initialized.

```yaml
Type: SwitchParameter
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
```

### -Description

The HALB Virtual Server description.

```yaml
Type: string
Required: False
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```

### -PublicAddress

The HALB Virtual Server Public Address.

```yaml
Type: string
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```

### -VirtualIPv4

The IPv4 of the HALB Virtual Server.

```yaml
Type: string
Required: False
Position: 4
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```

### -SubnetMask

The Subnet Mask of the HALB Virtual Server.

```yaml
Type: string
Required: False
Position: 5
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```

### -VirtualIPv6

The IPv6 of the HALB Virtual Server.

```yaml
Type: string
Required: False
Position: 6
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```

### -PrefixIPV6

The IPv6 Prefix of the HALB Virtual Server.

```yaml
Type: uint
Required: False
Position: 7
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```

### -EnableTunneling

Enable/Disable the RDP/UDP of the HALB Virtual Server.

```yaml
Type: bool
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```

### -MaxTCPConnections

The Maximum allowed TCP Connections to the HALB Virtual Server.

```yaml
Type: uint
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```

### -VRRPAuthenticationPassword

The VRRP Authentication password.

```yaml
Type: SecureString
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```

### -ClientIdleTimeout

The client inactivity timeout.

```yaml
Type: uint
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```

### -GatewayConnectionTimeout

The Gateway connection timeout.

```yaml
Type: uint
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```

### -ClientQueueTimeout

The client queue timeout.

```yaml
Type: uint
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```

### -GatewayIdleTimeout

The Gateway inactivity timeout.

```yaml
Type: uint
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```

### -SessionRate

The amount of TCP connections per second.

```yaml
Type: uint
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```

### -GatewayHealthCheckIntervals

The Gateway Health check intervals in seconds.

```yaml
Type: uint
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```

### -VRRPVirtualRouterID

The Virtual Router ID of HALB Virtual Server (if not set, the router ID will be automatically computed).

```yaml
Type: uint
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```

### -VRRPBroadcastInterval

The VRRP broadcast interval in minutes.

```yaml
Type: uint
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```

### -VRRPHealthScriptCheckInterval

The VRRP health script check interval in seconds.

```yaml
Type: uint
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```

### -VRRPHealthScriptCheckTimeout

The VRRP health script check timeout in seconds.

```yaml
Type: uint
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```

### -VRRPAdvertisementInterval

The VRRP Advertisement interval in seconds.

```yaml
Type: uint
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```

### -KeepLBProxyConfig

Enable/Disable keeping of existing loadbalancing settings.

```yaml
Type: bool
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```

### -KeepVRRPConfig

Enable/Disable keeping of existing VRRP/keepalive settings.

```yaml
Type: bool
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```

### -LBGateways

The list of the Non-SSL Gateways for HALB Virtual Server.

```yaml
Type: List`1
Required: False
Position: 10
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```

### -LBGatewayPort

The Non-SSL Gateway port.

```yaml
Type: uint
Required: False
Position: 11
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```

### -SSLMode

The SSL Mode to use for SSL Gateways.

Possible values: SSLOffloading, SSLPassthrough

Type reference: [LoadBalancingSSLMode](https://docs.parallels.com/landing/ras-powershell-api-guide/rasadmin/types/loadbalancingsslmode.md)

```yaml
Type: LoadBalancingSSLMode
Required: False
Position: 13
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```

### -LBSSLGateways

The list of the SSL Gateways for HALB Virtual Server.

```yaml
Type: List`1
Required: False
Position: 14
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```

### -LBSSLGatewayPort

The SSL Gateway port.

```yaml
Type: uint
Required: False
Position: 15
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```

### -AcceptedSSLVersion

The SSL version to be used for the SSL Gateways.

Possible values: TLSv1, TLSv1\_1, TLSv1\_2, TLSv1\_3

Type reference: [AcceptedSSLVersion](https://docs.parallels.com/landing/ras-powershell-api-guide/rasadmin/types/acceptedsslversion.md)

```yaml
Type: AcceptedSSLVersion
Required: False
Position: 16
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```

### -CipherStrength

The Cipher strength to be used for the SSL Gateways.

Possible values: Low, Medium, High, Custom

Type reference: [CipherStrength](https://docs.parallels.com/landing/ras-powershell-api-guide/rasadmin/types/cipherstrength.md)

```yaml
Type: CipherStrength
Required: False
Position: 17
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```

### -CipherPreference

Enable or disable 'Use ciphers according to server preference'.

```yaml
Type: bool
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```

### -SSLCustomCipher

The SSL custom cipher for SSL Gateways.

```yaml
Type: string
Required: False
Position: 18
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```

### -CertificateID

The certificate ID.

```yaml
Type: uint
Required: False
Position: 19
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```

### -DeviceManagerGateways

The list of the Device Management Gateways for HALB Virtual Server.

```yaml
Type: List`1
Required: False
Position: 21
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```

### CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about\_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216).

## INPUTS

### None

## OUTPUTS

### [HALBSettings](https://docs.parallels.com/landing/ras-powershell-api-guide/rasadmin/types/halbsettings.md)

## RELATED LINKS

* [Get-RASHALB](https://docs.parallels.com/landing/ras-powershell-api-guide/rasadmin/cmdlets/get-rashalb.md)
* [Set-RASHALB](https://docs.parallels.com/landing/ras-powershell-api-guide/rasadmin/cmdlets/set-rashalb.md)
* [Remove-RASHALB](https://docs.parallels.com/landing/ras-powershell-api-guide/rasadmin/cmdlets/remove-rashalb.md)
* [Get-RASHALBStatus](https://docs.parallels.com/landing/ras-powershell-api-guide/rasadmin/cmdlets/get-rashalbstatus.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/rasadmin/cmdlets/new-rashalb.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.
