Products
Support
Partners
Documentation

Set-RASHALB

NAME

Set-RASHALB

SYNOPSIS

Updates the settings of a specific HALB Virtual Server.

SYNTAX

Set-RASHALB [[-Id] <uint>] [[-LBGateways] <List`1>] [[-LBGatewayPort] <uint>] [[-EnableSSLPayload] <bool>] [[-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>] [[-NewName] <string>] [[-EnableDeviceManagement] <bool>] [[-DeviceManagerGateways] <List`1>] [[-IPVersion] {Version4 | Version6 | BothVersions}] [[-VirtualIPv4] <string>] [[-SubnetMask] <string>] [[-VirtualIPv6] <string>] [[-PrefixIPV6] <uint>] [[-EnableGatewayPayload] <bool>] [-CipherPreference <bool>] [-ClientIdleTimeout <uint>] [-ClientQueueTimeout <uint>] [-Enabled <bool>] [-EnableOSUpdates <bool>] [-EnableTunneling <bool>] [-GatewayConnectionTimeout <uint>] [-GatewayHealthCheckIntervals <uint>] [-GatewayIdleTimeout <uint>] [-KeepLBProxyConfig <bool>] [-KeepVRRPConfig <bool>] [-MaxTCPConnections <uint>] [-PublicAddress <string>] [-SessionRate <uint>] [-VRRPAdvertisementInterval <uint>] [-VRRPAuthenticationPassword <SecureString>] [-VRRPBroadcastInterval <uint>] [-VRRPHealthScriptCheckInterval <uint>] [-VRRPHealthScriptCheckTimeout <uint>] [-VRRPVirtualRouterID <uint>] [<CommonParameters>] Set-RASHALB [-InputObject] <HALBSettings> [[-LBGateways] <List`1>] [[-LBGatewayPort] <uint>] [[-EnableSSLPayload] <bool>] [[-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>] [[-NewName] <string>] [[-EnableDeviceManagement] <bool>] [[-DeviceManagerGateways] <List`1>] [[-IPVersion] {Version4 | Version6 | BothVersions}] [[-VirtualIPv4] <string>] [[-SubnetMask] <string>] [[-VirtualIPv6] <string>] [[-PrefixIPV6] <uint>] [[-EnableGatewayPayload] <bool>] [-CipherPreference <bool>] [-ClientIdleTimeout <uint>] [-ClientQueueTimeout <uint>] [-Enabled <bool>] [-EnableOSUpdates <bool>] [-EnableTunneling <bool>] [-GatewayConnectionTimeout <uint>] [-GatewayHealthCheckIntervals <uint>] [-GatewayIdleTimeout <uint>] [-KeepLBProxyConfig <bool>] [-KeepVRRPConfig <bool>] [-MaxTCPConnections <uint>] [-PublicAddress <string>] [-SessionRate <uint>] [-VRRPAdvertisementInterval <uint>] [-VRRPAuthenticationPassword <SecureString>] [-VRRPBroadcastInterval <uint>] [-VRRPHealthScriptCheckInterval <uint>] [-VRRPHealthScriptCheckTimeout <uint>] [-VRRPVirtualRouterID <uint>] [<CommonParameters>] Set-RASHALB [-Name] <string> [[-SiteId] <uint>] [[-LBGateways] <List`1>] [[-LBGatewayPort] <uint>] [[-EnableSSLPayload] <bool>] [[-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>] [[-NewName] <string>] [[-EnableDeviceManagement] <bool>] [[-DeviceManagerGateways] <List`1>] [[-IPVersion] {Version4 | Version6 | BothVersions}] [[-VirtualIPv4] <string>] [[-SubnetMask] <string>] [[-VirtualIPv6] <string>] [[-PrefixIPV6] <uint>] [[-EnableGatewayPayload] <bool>] [-CipherPreference <bool>] [-ClientIdleTimeout <uint>] [-ClientQueueTimeout <uint>] [-Enabled <bool>] [-EnableOSUpdates <bool>] [-EnableTunneling <bool>] [-GatewayConnectionTimeout <uint>] [-GatewayHealthCheckIntervals <uint>] [-GatewayIdleTimeout <uint>] [-KeepLBProxyConfig <bool>] [-KeepVRRPConfig <bool>] [-MaxTCPConnections <uint>] [-PublicAddress <string>] [-SessionRate <uint>] [-VRRPAdvertisementInterval <uint>] [-VRRPAuthenticationPassword <SecureString>] [-VRRPBroadcastInterval <uint>] [-VRRPHealthScriptCheckInterval <uint>] [-VRRPHealthScriptCheckTimeout <uint>] [-VRRPVirtualRouterID <uint>] [<CommonParameters>]

DESCRIPTION

Updates the settings of a specific HALB Virtual Server.

PARAMETERS

-Id <uint> The Id of the HALB Virtual Server. 

        Required?                    false
        Position?                    0
        Default value                0
        Accept pipeline input?       false
        Accept wildcard characters?  false

-Name <string> The name of the HALB Virtual Server. 

        Required?                    true
        Position?                    0
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false

-SiteId <uint> The site ID where the HALB settings will be created. 

        Required?                    false
        Position?                    1
        Default value                0
        Accept pipeline input?       false
        Accept wildcard characters?  false

-NewName <string> The new name for the HALB Virtual Server. 

        Required?                    false
        Position?                    2
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false

-Enabled <bool> Enable/Disable HALB Virtual Server. 

        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false

-IPVersion <IPVersion> The supported IP versions of the HALB Virtual Server. Possible values: Version4, Version6, BothVersions 

        Required?                    false
        Position?                    3
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false

-EnableGatewayPayload <bool> Enable/Disable the Non-SSL Gateway configuration of the HALB Virtual Server . 

        Required?                    false
        Position?                    9
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false

-EnableSSLPayload <bool> Enable/Disable the SSL Gateway configuration of the HALB Virtual Server. 

        Required?                    false
        Position?                    12
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false

-EnableDeviceManagement <bool> Enable/Disable the Device Management configuration of the HALB Virtual Server. 

        Required?                    false
        Position?                    20
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false

-InputObject <HALBSettings> An object of type HALBSettings. The object is obtained using the Get-RASHALB cmdlet. 

        Required?                    true
        Position?                    0
        Default value                
        Accept pipeline input?       true (ByValue)
        Accept wildcard characters?  false

-Description <string> The HALB Virtual Server description. 

        Required?                    false
        Position?                    2
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false

-PublicAddress <string> The HALB Virtual Server Public Address. 

        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false

-VirtualIPv4 <string> The IPv4 of the HALB Virtual Server. 

        Required?                    false
        Position?                    4
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false

-SubnetMask <string> The Subnet Mask of the HALB Virtual Server. 

        Required?                    false
        Position?                    5
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false

-VirtualIPv6 <string> The IPv6 of the HALB Virtual Server. 

        Required?                    false
        Position?                    6
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false

-PrefixIPV6 <uint> The IPv6 Prefix of the HALB Virtual Server. 

        Required?                    false
        Position?                    7
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false

-EnableTunneling <bool> Enable/Disable the RDP/UDP of the HALB Virtual Server. 

        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false

-MaxTCPConnections <uint> The Maximum allowed TCP Connections to the HALB Virtual Server. 

        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false

-VRRPAuthenticationPassword <SecureString> The VRRP Authentication password. 

        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false

-ClientIdleTimeout <uint> The client inactivity timeout. 

        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false

-GatewayConnectionTimeout <uint> The Gateway connection timeout. 

        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false

-ClientQueueTimeout <uint> The client queue timeout. 

        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false

-GatewayIdleTimeout <uint> The Gateway inactivity timeout. 

        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false

-SessionRate <uint> The amount of TCP connections per second. 

        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false

-GatewayHealthCheckIntervals <uint> The Gateway Health check intervals in seconds. 

        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false

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

        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false

-VRRPBroadcastInterval <uint> The VRRP broadcast interval in minutes. 

        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false

-VRRPHealthScriptCheckInterval <uint> The VRRP health script check interval in seconds. 

        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false

-VRRPHealthScriptCheckTimeout <uint> The VRRP health script check timeout in seconds. 

        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false

-VRRPAdvertisementInterval <uint> The VRRP Advertisement interval in seconds. 

        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false

-EnableOSUpdates <bool> Enable/Disable OS updates. 

        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false

-KeepLBProxyConfig <bool> Enable/Disable keeping of existing loadbalancing settings. 

        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false

-KeepVRRPConfig <bool> Enable/Disable keeping of existing VRRP/keepalive settings. 

        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false

-LBGateways <List`1> The list of the Non-SSL Gateways for HALB Virtual Server. 

        Required?                    false
        Position?                    10
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false

-LBGatewayPort <uint> The Non-SSL Gateway port. 

        Required?                    false
        Position?                    11
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false

-SSLMode <LoadBalancingSSLMode> The SSL Mode to use for SSL Gateways. Possible values: SSLOffloading, SSLPassthrough 

        Required?                    false
        Position?                    13
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false

-LBSSLGateways <List`1> The list of the SSL Gateways for HALB Virtual Server. 

        Required?                    false
        Position?                    14
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false

-LBSSLGatewayPort <uint> The SSL Gateway port. 

        Required?                    false
        Position?                    15
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false

-AcceptedSSLVersion <AcceptedSSLVersion> The SSL version to be used for the SSL Gateways. Possible values: TLSv1, TLSv1_1, TLSv1_2, TLSv1_3 

        Required?                    false
        Position?                    16
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false

-CipherStrength <CipherStrength> The Cipher strength to be used for the SSL Gateways. Possible values: Low, Medium, High, Custom 

        Required?                    false
        Position?                    17
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false

-CipherPreference <bool> Enable or disable 'Use ciphers according to server preference'. 

        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false

-SSLCustomCipher <string> The SSL custom cipher for SSL Gateways. 

        Required?                    false
        Position?                    18
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false

-CertificateID <uint> The certificate ID. 

        Required?                    false
        Position?                    19
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false

-DeviceManagerGateways <List`1> The list of the Device Management Gateways for HALB Virtual Server. 

        Required?                    false
        Position?                    21
        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 .

INPUTS

HALBSettings

OUTPUTS

-none-

EXAMPLES

---------- EXAMPLE 1 ---------- Set-RASHALB -Id 1 -NewName "HALB-VS" -VirtualIPv4 "1.2.3.4" -SubnetMask "255.255.255.0" Update the HALB Virtual Server settings by ID. ---------- EXAMPLE 2 ---------- Set-RASHALB -Name "HALB" -NewName "HALB-VS" -IPVersion Version6 -VirtualIPv6 "1.2.3.4" -PrefixIPV6 64 Update the HALB Virtual Server settings by name.

PreviousSet-RASGatewayDefaultSettingsNextSet-RASHALBDevicePriority

Last updated

Other Resources

Community ForumKnowledge Base@Parallels CaresRequest Support

Feedback

Leave a feedback

Social media

FacebookTwitterLinkedinYouTube

© 2024 Parallels International GmbH. All rights reserved.